package odoc

You can search for identifiers within the package.

in-package search v0.2.0

OCaml Documentation Generator

Install

Dune Dependency

github.com Readme Changelog Edit opam file Versions (24)

Authors

Maintainers

Sources

odoc-3.0.0.tbz

sha256=ce84fa7e0cc5f3e8a54e6adeb10826152798b602057b9e46c5ae7e5d5206812b

sha512=9febd413450ca2e3824c9ef7e1c9ae8d8094aa72ed71327a69d8d6b42f6f197b3f3f40d674de0d11fa1242ee0df95c693b5d74467d530704e1339f3a523452f6

doc/odoc.odoc_utils/Odoc_utils/Io_utils/index.html

Module `Odoc_utils.Io_utils`Source

with_open_* are resource safe wrappers around opening and closing channels. They are equivalent to the same functions in OCaml 4.14's In_channel and Out_channel.

Sourceval _with_resource : 'a -> close:('a -> unit) -> ('a -> 'b) -> 'b

Sourceval with_open_in : string -> (in_channel -> 'a) -> 'a

Sourceval with_open_in_bin : string -> (in_channel -> 'a) -> 'a

Sourceval fold_lines : string -> (string -> 'a -> 'a) -> 'a -> 'a

Read a file line-by-line by folding f.

Sourceval read_lines : string -> string list

Read a file as a list of lines.

Sourceval with_open_out : string -> (out_channel -> 'a) -> 'a

Sourceval with_open_out_bin : string -> (out_channel -> 'a) -> 'a

Sourceval with_formatter_out : string -> (Format.formatter -> 'a) -> 'a

Like with_open_out but operate on a Format buffer.

Sourceval marshal : string -> 'a -> unit

Shortcuts for composing with_open_* functions and Marshal.

Sourceval unmarshal : string -> 'a