Index of values

B
buffer [Markup]

Evaluates to a stream that retrieves successive bytes from the given buffer.

C
channel [Markup_lwt_unix]

Evaluates to a stream that retrieves successive bytes from the given channel.

channel [Markup]

Evaluates to a stream that retrieves bytes from the given channel.

compare_locations [Markup]

Orders locations according to their appearance in an input stream, i.e.

content [Markup]

Filters out all signals besides `Start_element, `End_element, and `Text.

D
decode [Markup.ASYNCHRONOUS.Encoding]
decode [Markup.Encoding]

Applies a decoder to a byte stream.

drain [Markup.ASYNCHRONOUS]
drain [Markup]

drain s eagerly consumes s.

E
ebcdic [Markup.Encoding]

Code page 37.

elements [Markup]

elements f s scans the signal stream s for `Start_element (name, attributes) signals that satisfy f name attributes.

ensure_tail_calls [Markup_lwt]
F
file [Markup_lwt_unix]

Evaluates to a pair s, close, where reading from stream s retrieves successive bytes from the given file, and completing close () closes the file.

file [Markup]

file path opens the file at path, then evaluates to a pair s, close, where reading from stream s retrieves successive bytes from the file, and calling close () closes the file.

filter [Markup.ASYNCHRONOUS]
filter [Markup]

filter f s is s without the items for which f evaluates to false.

filter_map [Markup.ASYNCHRONOUS]
filter_map [Markup]

filter_map f s lazily applies f to each item v of s.

fn [Markup.ASYNCHRONOUS]
fn [Markup]

fn f is a stream that retrives bytes by calling f ().

fold [Markup.ASYNCHRONOUS]
fold [Markup]

fold f init s eagerly folds over the items v, v', v'', ...

from_tree [Markup]

Deconstructs tree data structures of type 'a into signal streams.

H
html [Markup.Ns]

http://www.w3.org/1999/xhtml.

html5 [Markup]

Converts a signal stream into an HTML5 signal stream by stripping any document type declarations, XML declarations, and processing instructions, and prefixing the HTML5 doctype declaration.

I
iso_8859_1 [Markup.Encoding]
iter [Markup.ASYNCHRONOUS]
iter [Markup]

iter f s eagerly applies f to each item of s, i.e.

L
load [Markup.ASYNCHRONOUS]

load s converts a general stream s to a synchronous stream by buffering it.

location [Markup]

Evaluates to the location of the last signal emitted on the parser's signal stream.

lwt_stream [Markup_lwt]

Adapts an Lwt stream to a Markup.ml stream.

M
map [Markup.ASYNCHRONOUS]
map [Markup]

map f s lazily applies f to each item of s, and produces the resulting stream.

mathml [Markup.Ns]

http://www.w3.org/1998/Math/MathML.

N
next [Markup.ASYNCHRONOUS]
next [Markup]

Retrieves the next item in the stream, if any, and removes it from the stream.

normalize_text [Markup]

Concatenates adjacent `Text signals, then eliminates all empty strings, then all `Text [] signals.

O
of_list [Markup]

Produces a (lazy) stream from the given list.

P
parse_html [Markup.ASYNCHRONOUS]
parse_html [Markup]

Similar to Markup.parse_xml, but parses HTML with embedded SVG and MathML, never emits signals `Xml or `PI, and ~context has a different type on tag `Fragment.

parse_xml [Markup.ASYNCHRONOUS]
parse_xml [Markup]

Creates a parser that converts an XML byte stream to a signal stream.

peek [Markup.ASYNCHRONOUS]
peek [Markup]

Retrieves the next item in the stream, if any, but does not remove the item from the stream.

pretty_print [Markup]

Adjusts the whitespace in the `Text signals in the given stream so that the output appears nicely-indented when the stream is converted to bytes and written.

S
signal_to_string [Markup]

Provides a human-readable representation of signals for debugging.

signals [Markup]

Converts a parser to its underlying signal stream.

stream [Markup.ASYNCHRONOUS]
stream [Markup]

stream f creates a stream that repeatedly calls f ().

string [Markup]

Evaluates to a stream that retrieves successive bytes from the given string.

strings_to_bytes [Markup]

strings_to_bytes s is the stream of all the bytes of all strings in s.

svg [Markup.Ns]

http://www.w3.org/2000/svg.

T
text [Markup]

Extracts all the text in a signal stream by discarding all markup.

to_buffer [Markup.ASYNCHRONOUS]
to_buffer [Markup]

Eagerly retrieves bytes from the given stream and places them into a buffer.

to_channel [Markup_lwt_unix]

Writes bytes from the given stream to the given channel.

to_channel [Markup]

Eagerly retrieves bytes from the given stream and writes them to the given channel.

to_file [Markup_lwt_unix]

Writes bytes from the given stream to the given file.

to_file [Markup]

Eagerly retrieves bytes from the given stream and writes them to the given file.

to_list [Markup.ASYNCHRONOUS]
to_list [Markup]

Eagerly converts the given stream to a list.

to_lwt_stream [Markup_lwt]

Adapts a Markup.ml stream to an Lwt stream.

to_string [Markup.ASYNCHRONOUS]
to_string [Markup.Error]

Converts an error to human-readable form.

to_string [Markup]

Eagerly retrieves bytes from the given stream and assembles a string.

transform [Markup.ASYNCHRONOUS]
transform [Markup]

transform f init s lazily creates a stream by repeatedly applying f acc v, where acc is an accumulator whose initial value is init, and v is consecutive values of s.

tree [Markup.ASYNCHRONOUS]
tree [Markup]

This function's type signature may look intimidating, but it is actually easy to use.

trees [Markup]

Like Markup.tree, but converts all top-level trees, not only the first one.

trim [Markup]

Trims insignificant whitespace in an HTML signal stream.

U
ucs_4be [Markup.Encoding]
ucs_4be_transposed [Markup.Encoding]
ucs_4le [Markup.Encoding]
ucs_4le_transposed [Markup.Encoding]
us_ascii [Markup.Encoding]
utf_16 [Markup.Encoding]
utf_16be [Markup.Encoding]
utf_16le [Markup.Encoding]
utf_8 [Markup.Encoding]
W
windows_1251 [Markup.Encoding]
windows_1252 [Markup.Encoding]
write_html [Markup.ASYNCHRONOUS]
write_html [Markup]

Similar to Markup.write_xml, but emits HTML5 instead of XML.

write_xml [Markup.ASYNCHRONOUS]
write_xml [Markup]

Converts an XML signal stream to a byte stream.

X
xhtml [Markup]

Similar to Markup.html5, but does not strip processing instructions, and prefixes an XHTML document type declaration and an XML declaration.

xhtml_entity [Markup]

Translates XHTML entities.

xlink [Markup.Ns]

http://www.w3.org/1999/xlink.

xml [Markup.Ns]

http://www.w3.org/XML/1998/namespace.

xmlns [Markup.Ns]

http://www.w3.org/2000/xmlns/.