package lwt
Install
Dune Dependency
Authors
Maintainers
Sources
md5=ba3659a8918d8e7cb0f4ef9a83945f90
sha512=9f46fb2e56dc7bd57a12d5ab4dc68719947a1462f336087a95e991d087bb9b5b8dee2592d0f7d35abc507d9a641dd221c44c949c81d00e26c673a067d94ba3f4
doc/lwt.unix/Lwt_fmt/index.html
Module Lwt_fmt
Source
Format API for Lwt-powered IOs
This module bridges the gap between Format
and Lwt
. Although it is not required, it is recommended to use this module with the Fmt
library.
Compared to regular formatting function, the main difference is that printing statements will now return promises instead of blocking.
Returns a promise that prints on the standard output. Similar to Format.printf
.
Returns a promise that prints on the standard error. Similar to Format.eprintf
.
Formatters
Lwt enabled formatters
make_stream ()
returns a formatter and a stream of all the writing order given on that stream.
of_channel oc
creates a formatter that writes to the channel oc
.
Formatter printing on Lwt_io.stdout
.
Formatter printing on Lwt_io.stdout
.
make_formatter ~commit ~fmt
creates a new lwt formatter based on the Format.formatter
fmt
. The commit
function will be called by the printing functions to update the underlying channel.
get_formatter fmt
returns the underlying Format.formatter
. To access the underlying formatter during printing, it isvrecommended to use %t
and %a
.
Printing
flush fmt
flushes the formatter (as with Format.pp_print_flush
) and executes all the printing action on the underlying channel.
Low level functions
write_order oc o
applies the order o
on the channel oc
.