# Index of values

A
add_uchar [Xmlm.Buffer] | Adds the given (guaranteed valid) unicode code point to a buffer.
append [Xmlm.String] | Concatenates two strings.
C
clear [Xmlm.Buffer] | Clears the buffer.
compare [Xmlm.String] | String comparison.
contents [Xmlm.Buffer] | Returns the buffer contents.
create [Xmlm.Buffer] | Creates a buffer of the given size.
E
empty [Xmlm.String] | The empty string.
eoi [Xmlm.S] |
eoi [Xmlm] | Returns `true` if the end of input is reached.
error_message [Xmlm.S] |
error_message [Xmlm] | Converts the error to an english error message.
I
input [Xmlm.S] |
input [Xmlm] | Inputs a signal.
input_doc_tree [Xmlm.S] |
input_doc_tree [Xmlm] | Same as `Xmlm.input_tree` but reads a complete well-formed sequence of signals.
input_tree [Xmlm.S] |

input_tree [Xmlm]

If the next signal is a : ``Data` signal, inputs it and invokes `data` with the character data., ``El_start` signal, inputs the sequence of signals until its matching ``El_end` and invokes `el` and `data` as follows `el`, is called on each ``El_end` signals with the corresponding ``El_start` tag and the result of the callback invocation for the element's children., `data`, is called on each ``Data` signals with the character data. This function won't be called twice consecutively or with the empty string., Other signals, raises `Invalid_argument`.

iter [Xmlm.String] | Iterates over the unicode code point of the given string.
L
length [Xmlm.Buffer] | Returns the number of characters contained in the buffer.
length [Xmlm.String] | Returns the length of the string.
lowercase [Xmlm.String] | New string with uppercase letter translated to lowercase (correctness is only needed for ASCII code point).
M
make_input [Xmlm.S] |
make_input [Xmlm] | Returns a new input abstraction reading from the given source.
make_output [Xmlm.S] |
make_output [Xmlm] | Returns a new output abstraction writing to the given destination.
N
ns_xml [Xmlm.S] |
ns_xml [Xmlm] | Namespace name value bound to the reserved `"xml"` prefix.
ns_xmlns [Xmlm.S] |
ns_xmlns [Xmlm] | Namespace name value bound to the reserved `"xmlns"` prefix.
O
of_string [Xmlm.String] | String from an OCaml string.
output [Xmlm.S] |
output [Xmlm] | Outputs a signal.
output_depth [Xmlm.S] |
output_depth [Xmlm] | `output_depth o` is `o`'s current element nesting level (undefined before the first ``El_start` and after the last ``El_end`).
output_doc_tree [Xmlm.S] |
output_doc_tree [Xmlm] | Same as `Xmlm.output_tree` but outputs a complete well-formed sequence of signals.
output_tree [Xmlm.S] |
output_tree [Xmlm] | Outputs signals corresponding to a value by recursively applying the given value deconstructor.
P
peek [Xmlm.S] |
peek [Xmlm] | Same as `val-input` but doesn't remove the signal from the sequence.
pos [Xmlm.S] |
pos [Xmlm] | Current position in the input abstraction.
pp_attribute [Xmlm] | `pp_attribute ppf att` prints an unspecified representation of `att` on `ppf`.
pp_dtd [Xmlm] | `pp_dtd ppf dtd` prints an unspecified representation of `dtd` on `ppf`.
pp_name [Xmlm] | `pp_name ppf name` prints an unspecified representation of `name` on `ppf`.
pp_signal [Xmlm] | `pp_signal ppf s` prints an unspecified representation of `s` on `ppf`.
pp_tag [Xmlm] | `pp_tag ppf tag` prints an unspecified representation of `tag` on `ppf`.
T
to_utf_8 [Xmlm.String] | `to_utf_8 f v s`, is `f (... (f (f v s1) s2) ...) sn`.