irmin-pack 3.5.2 · OCaml Package

type t

type misc_error = Unix.error * string * string

val misc_error_t : misc_error Irmin.Type.t

type create_error = [

]

type open_error = [

]

type read_error = [

]

type write_error = [

]

type close_error = [

]

type mkdir_error = [

]

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 copy_file : 
  src:string ->
  dst:string ->
  (unit, [> `Sys_error of string ]) Stdlib.result

val mkdir : string -> (unit, [> mkdir_error ]) Stdlib.result

val unlink : string -> (unit, [> `Sys_error of string ]) Stdlib.result

val read_to_string : 
  t ->
  off:Optint.Int63.t ->
  len:int ->
  (string, [> read_error ]) Stdlib.result

val read_all_to_string : 
  t ->
  (string, [> `Closed | `Io_misc of misc_error ]) Stdlib.result

val read_size : t -> (Optint.Int63.t, [> read_error ]) Stdlib.result

val size_of_path : 
  string ->
  (Optint.Int63.t,
    [> `Io_misc of misc_error | `No_such_file_or_directory | `Not_a_file ])
    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

package irmin-pack