package irmin-pack

  1. Overview
  2. Docs
package irmin-pack
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Control.IoSource

Sourcetype t = Io.t
Sourcetype misc_error = Io.misc_error
Sourceval misc_error_t : misc_error Irmin.Type.t
Sourcetype create_error = [
  1. | `File_exists of string
  2. | `Io_misc of misc_error
]
Sourcetype open_error = [
  1. | `Io_misc of misc_error
  2. | `No_such_file_or_directory
  3. | `Not_a_file
]
Sourcetype read_error = [
  1. | `Closed
  2. | `Invalid_argument
  3. | `Io_misc of misc_error
  4. | `Read_out_of_bounds
]
Sourcetype write_error = [
  1. | `Closed
  2. | `Io_misc of misc_error
  3. | `Ro_not_allowed
]
Sourcetype close_error = [
  1. | `Double_close
  2. | `Io_misc of misc_error
]
Sourcetype mkdir_error = [
  1. | `File_exists of string
  2. | `Invalid_parent_directory
  3. | `Io_misc of misc_error
  4. | `No_such_file_or_directory
]
Sourceval create : path:string -> overwrite:bool -> (t, [> create_error ]) result
Sourceval open_ : path:string -> readonly:bool -> (t, [> open_error ]) result
Sourceval close : t -> (unit, [> close_error ]) result
Sourceval write_string : t -> off:Optint.Int63.t -> string -> (unit, [> write_error ]) result
Sourceval fsync : t -> (unit, [> write_error ]) result
Sourceval move_file : src:string -> dst:string -> (unit, [> `Sys_error of string ]) result
Sourceval mkdir : string -> (unit, [> mkdir_error ]) result
Sourceval read_to_string : t -> off:Optint.Int63.t -> len:int -> (string, [> read_error ]) result
Sourceval read_all_to_string : t -> (string, [> `Closed | `Io_misc of misc_error ]) result
Sourceval read_size : t -> (Optint.Int63.t, [> read_error ]) result
Sourceval classify_path : string -> [> `Directory | `File | `No_such_file_or_directory | `Other ]
Sourceval readonly : t -> bool
Sourceval path : t -> string
Sourceval page_size : int
Sourceval read_exn : t -> off:Optint.Int63.t -> len:int -> bytes -> unit
Sourceval write_exn : t -> off:Optint.Int63.t -> len:int -> string -> unit
Sourceval raise_misc_error : misc_error -> 'a
Sourceval catch_misc_error : (unit -> 'a) -> ('a, [> `Io_misc of misc_error ]) result
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct