package odoc

  1. Overview
  2. Docs
OCaml Documentation Generator

Install 

dune-project
 Dependency

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

Authors

  1. Anton Bachin
  2. Daniel Bünzli
  3. D
    David Sheets <sheets@alum.mit.edu>
  4. J
    Jon Ludlam <jon@recoil.org>
  5. J
    Jules Aguillon <juloo.dsi@gmail.com>
  6. L
    Leo White <leo@lpw25.net>
  7. L
    Lubega Simon <lubegasimon73@gmail.com>
  8. P
    Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>
  9. T
    Thomas Refis <trefis@janestreet.com>

Maintainers

  1. Daniel Bünzli
  2. J
    Jon Ludlam <jon@recoil.org>
  3. J
    Jules Aguillon <juloo.dsi@gmail.com>
  4. P
    Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>

Sources

odoc-3.1.0.tbz
sha256=355b3cfff4934903cbaed8b51ce35e333e8609932d230294200a9f2d42ffa914
sha512=f78318d0a16164a9cd16ee02f611c2e00d32b772fe38e992d6db6ec94b1c00cd9c377fbfe64031b8f245e57b2f3aac9364108327e7f1693533ddcff94c476e05

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

Module Odoc_utils.Io_utilsSource

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