package avro

  1. Overview
  2. Docs
On This Page
  1. Writing

Module Avro.OutputSource

A sink for bytes.

Serializing objects always ends up writing bytes to some output.

Sourcetype t
Sourceval of_buffer : Buffer.t -> t

Output into the given buffer. Encoded data can be accessed using Buffer.contents.

Sourceval of_chan : out_channel -> t

Write data to the given channel.

Sourceval with_file : ?flags:open_flag list -> ?mode:int -> string -> (t -> 'a) -> 'a

with_file file f opens file, obtaining a channel oc, calls f out with an output that writes to the channel oc. When f out returns, this closes oc and returns the same as f.

Sourceval of_iobuf_chain : Avro__.Iobuf.Pool.t -> t * Avro__.Iobuf.Chain.t

of_iobuf_chain pool is an output that writes to buffers allocated from pool. It also returns a chain of buffers into which the content is written

Sourcemodule type CUSTOM = sig ... end

Custom output

Sourceval of_custom : (module CUSTOM) -> t

Make a custom output.

Writing

Sourceval write_byte : t -> char -> unit

Write a single byte.

Sourceval write_slice : t -> bytes -> int -> int -> unit

Write the given slice.

Sourceval write_bool : t -> bool -> unit
Sourceval write_int : t -> int -> unit
Sourceval write_int64 : t -> int64 -> unit
Sourceval write_float32 : t -> float -> unit
Sourceval write_float64 : t -> float -> unit
Sourceval write_string : t -> string -> unit
Sourceval write_string_of_len : t -> int -> string -> unit
Sourceval write_array : (t -> 'a -> unit) -> t -> 'a array -> unit
Sourceval write_map : (t -> 'a -> unit) -> t -> 'a Map.Make(String).t -> unit
Sourceval flush : t -> unit

Hint to flush underlying buffer/channel/socket.