package biniou

  1. Overview
  2. Docs
Binary data format designed for speed, safety, ease of use and backward compatibility as protocols evolve

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (4)

Authors

  1. M
    Martin Jambon

Maintainers

  1. M
    martin@mjambon.com

Sources

biniou-1.2.2.tbz
sha256=8bf3ff17cd0ecb2d6b6d1d94cb08ef089d44caef96e9bae6be6839d428fa318f
sha512=7d03b3759a3a2e1c77713aa1b8375a1f1917f49d14fe5e3cb01d5e53a12e6385b7a3b0f4827f3be71182c31c416d780e1f9ef011dc205cb8f9b0ab2d8fc23cfd

doc/biniou/Bi_outbuf/index.html

Module Bi_outbufSource

Output buffer

Sourcetype t = {
  1. mutable o_s : bytes;
    (*

    Buffer string

    *)
  2. mutable o_max_len : int;
    (*

    Same as String.length s

    *)
  3. mutable o_len : int;
    (*

    Length of the data present in the buffer = current position in the buffer

    *)
  4. mutable o_offs : int;
    (*

    Length of data written and flushed out of the buffer. The total number of bytes written to the buffer is therefore o_offs + o_len.

    *)
  5. o_init_len : int;
    (*

    Initial length of the buffer

    *)
  6. o_make_room : t -> int -> unit;
    (*

    make_room buf n must provide space for at least the requested number of bytes n, typically by reallocating a larger buffer string or by flushing the data to a channel. This function is only called when there is not enough space for n bytes.

    *)
  7. mutable o_shared : Bi_share.Wr.tbl;
    (*

    Hash table used to map shared objects to positions in the input stream.

    *)
  8. o_shared_init_len : int;
    (*

    Initial length of the o_shared table.

    *)
}
Sourceval really_extend : t -> int -> unit

Default make_room function: reallocate a larger buffer string.

Sourceval flush_to_channel : out_channel -> t -> int -> unit

Alternate make_room function: write to an out_channel.

Sourceval create : ?make_room:(t -> int -> unit) -> ?shrlen:int -> int -> t

Create a buffer. The default make_room function is really_extend.

  • parameter shrlen

    initial size of the table used to store shared values.

Sourceval contents : t -> string

Returns the data currently in the buffer.

Sourceval create_channel_writer : ?len:int -> ?shrlen:int -> out_channel -> t
Sourceval flush_channel_writer : t -> unit

Pair of convenience functions for creating a buffer that flushes data to an out_channel when it is full.

Sourceval create_output_writer : ?len:int -> ?shrlen:int -> < output : string -> int -> int -> int.. > -> t
Sourceval flush_output_writer : t -> unit

Pair of convenience functions for creating a buffer that flushes data to an object when it is full.

Sourceval extend : t -> int -> unit

Guarantee that the buffer string has enough room for n additional bytes.

Sourceval alloc : t -> int -> int

alloc buf n makes room for n bytes and returns the position of the first byte in the buffer string buf.s. It behaves as if n arbitrary bytes were added and it is the user's responsibility to set them to some meaningful values by accessing buf.s directly.

Sourceval add_bytes : t -> bytes -> unit

Add bytes to the buffer.

  • since 1.2.0
Sourceval add_subbytes : t -> bytes -> int -> int -> unit

add_subbytes dst src srcpos len copies len bytes from bytes src to buffer dst starting from position srcpos.

  • since 1.2.0
Sourceval add_string : t -> string -> unit

Add a string to the buffer.

Sourceval add_substring : t -> string -> int -> int -> unit

add_substring dst src srcpos len copies len bytes from string src to buffer dst starting from position srcpos.

Sourceval add_char : t -> char -> unit

Add a byte to the buffer.

Sourceval add_char2 : t -> char -> char -> unit

Add two bytes to the buffer.

Sourceval add_char4 : t -> char -> char -> char -> char -> unit

Add four bytes to the buffer.

Sourceval unsafe_add_char : t -> char -> unit

Add a byte to the buffer without checking that there is enough room for it.

Sourceval clear : t -> unit

Remove any data present in the buffer and in the table holding shared objects.

Sourceval reset : t -> unit

Remove any data present in the buffer and reset it to its original size. Remove any data present in the table holding shared objects and reset it to its original size.