Abstract data corresponding to the encoder state and all its machinery.

The type for formatters of values of type 'a.

break ~indent ~len tries to add len spaces into the current line. If it fails - if we overflow the current line - we insert a new_line and fill the beginning of the new line with indent space characters.

fws is a specialization of break with indent = 1 and spaces = 1. This is the most used token to express an opportunity to break the line and be conform to RFC 822 and the folding-whitespace token.

spaces n is a specialization of break with spaces = n.

cut gives an opportunity to add a break line without indentation and spaces.

const pp v serialize v with pp.

atom pp expects a value 'a and serialize it with pp.

a expects a serializer pp and a value to serialize it then.

Alias of atom.

Alias of const.

new_line inserts a new line regardless how many bytes the current line has.

tbox indent creates a new box to indent any contents inside with indent spaces.

bbox creates a new box to indent any contents at the current position of the serializer.

close closes any boxes.

using f pp apply f on the value and use pp then to serialize the result.

string permits to serialize a string.

bytes permits to serialize a bytes.

bigstring permits to serialize a bigstring.

breakable permits to serialize a breakable string. If the given string is larger than the margin, the serializer is able to break the string to fit under the margin instead of to wait an opportunity (such as cut or fws) to break the line.

char permits to serialize a char.

list ~sep pp permits to serialize a list of values which can be serialized with pp. Between each values, we apply sep.

create ?margin ?new_line ~emitter weight creates a serializer bounded to weight elements. The serializer is limiter to emit margin bytes per lines and break the line with new_line (default to "\r\n").

emitter is called when the serializer is full. It gives to user what it needs to transmit to the output and it asks how many bytes the user was able to transmit.

is_empty ppf returns true if the serializer is empty. Otherwise, it returns false.

flush ppf enforces the serializer to call the internal emitter to transmit out what is serialized - even if ppf is not full.

kflush is flush with a kontinuation.

to_string ?margin ?new_line pp v serializes a value v with the serializer pp into a string.

to_stream ?margin ?new_line pp v serializes a value v with the serializer pp and it returns a function unit -> string option to transmit out the result chunk by chunk of the serialization.