package irmin-pack

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
type t
type misc_error = Unix.error * string * string
val misc_error_t : misc_error Irmin.Type.t
type create_error = [
  1. | `File_exists of string
  2. | `Io_misc of misc_error
]
type open_error = [
  1. | `Io_misc of misc_error
  2. | `No_such_file_or_directory
  3. | `Not_a_file
]
type read_error = [
  1. | `Invalid_argument
  2. | `Io_misc of misc_error
  3. | `Read_on_closed
  4. | `Read_out_of_bounds
]
type write_error = [
  1. | `Io_misc of misc_error
  2. | `Ro_not_allowed
  3. | `Write_on_closed
]
type close_error = [
  1. | `Double_close
  2. | `Io_misc of misc_error
]
type mkdir_error = [
  1. | `File_exists of string
  2. | `Invalid_parent_directory
  3. | `Io_misc of misc_error
  4. | `No_such_file_or_directory
]
val create : path:string -> overwrite:bool -> (t, [> create_error ]) Stdlib.result
val open_ : path:string -> readonly:bool -> (t, [> open_error ]) Stdlib.result
val close : t -> (unit, [> close_error ]) Stdlib.result
val write_string : t -> off:Optint.Int63.t -> string -> (unit, [> write_error ]) Stdlib.result
val fsync : t -> (unit, [> write_error ]) Stdlib.result
val move_file : src:string -> dst:string -> (unit, [> `Sys_error of string ]) Stdlib.result
val mkdir : string -> (unit, [> mkdir_error ]) Stdlib.result
val read_to_string : t -> off:Optint.Int63.t -> len:int -> (string, [> read_error ]) Stdlib.result
val read_size : t -> (Optint.Int63.t, [> read_error ]) Stdlib.result
val classify_path : string -> [> `Directory | `File | `No_such_file_or_directory | `Other ]
val readonly : t -> bool
val path : t -> string
val page_size : int
val read_exn : t -> off:Optint.Int63.t -> len:int -> bytes -> unit
val write_exn : t -> off:Optint.Int63.t -> len:int -> string -> unit
val raise_misc_error : misc_error -> 'a
val catch_misc_error : (unit -> 'a) -> ('a, [> `Io_misc of misc_error ]) Stdlib.result
OCaml

Innovation. Community. Security.