Module `Index.Io`Source

Sourcetype t = Io.t

Sourcetype misc_error = Io.misc_error

Sourceval misc_error_t : misc_error Irmin.Type.t

Sourcetype create_error = [

| `File_exists of string
| `Io_misc of misc_error

]

Sourcetype open_error = [

| `Io_misc of misc_error
| `No_such_file_or_directory
| `Not_a_file

]

Sourcetype read_error = [

| `Closed
| `Invalid_argument
| `Io_misc of misc_error
| `Read_out_of_bounds

]

Sourcetype write_error = [

| `Closed
| `Io_misc of misc_error
| `Ro_not_allowed

]

Sourcetype close_error = [

| `Double_close
| `Io_misc of misc_error

]

Sourcetype mkdir_error = [

| `File_exists of string
| `Invalid_parent_directory
| `Io_misc of misc_error
| `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

Source

val write_string : 
  t ->
  off:Optint.Int63.t ->
  string ->
  (unit, [> write_error ]) result

Sourceval fsync : t -> (unit, [> write_error ]) result

Source

val move_file : 
  src:string ->
  dst:string ->
  (unit, [> `Sys_error of string ]) result

Source

val copy_file : 
  src:string ->
  dst:string ->
  (unit, [> `Sys_error of string ]) result

Sourceval mkdir : string -> (unit, [> mkdir_error ]) result

Sourceval unlink : string -> (unit, [> `Sys_error of string ]) result

Source

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

Source

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

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

Source

val size_of_path : 
  string ->
  (Optint.Int63.t,
    [> `Io_misc of misc_error | `No_such_file_or_directory | `Not_a_file ])
    result

Source

val 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

Install

Dune Dependency

Authors

Maintainers

Sources

doc/irmin-pack.unix/Irmin_pack_unix/Maker/Make/File_manager/Index/Io/index.html

Module `Index.Io`Source

package irmin-pack

Install

Dune Dependency

Authors

Maintainers

Sources

doc/irmin-pack.unix/Irmin_pack_unix/Maker/Make/File_manager/Index/Io/index.html

Module Index.IoSource

Module `Index.Io`Source