package mirage-fs-unix

  1. Overview
  2. Docs
package mirage-fs-unix
Legend:
Library
Module
Module type
Parameter
Class
Class type
type fs_error = [
  1. | `Negative_bytes
  2. | `Unix_error of Unix.error
  3. | `Unix_errorno of int
]
type error = [
  1. | `Is_a_directory
  2. | `Negative_bytes
  3. | `No_directory_entry
  4. | `Not_a_directory
  5. | `Unix_error of Unix.error
  6. | `Unix_errorno of int
]
type write_error = [
  1. | `Directory_not_empty
  2. | `File_already_exists
  3. | `Is_a_directory
  4. | `Negative_bytes
  5. | `No_directory_entry
  6. | `No_space
  7. | `Not_a_directory
  8. | `Unix_error of Unix.error
  9. | `Unix_errorno of int
]
val pp_error : error Fmt.t
val pp_write_error : write_error Fmt.t
type 'a io = 'a Lwt.t
type t
val disconnect : t -> unit io
type page_aligned_buffer = Cstruct.t
val read : t -> string -> int -> int -> (page_aligned_buffer list, error) Pervasives.result io
val size : t -> string -> (int64, error) Pervasives.result io
val create : t -> string -> (unit, write_error) Pervasives.result io
val mkdir : t -> string -> (unit, write_error) Pervasives.result io
val destroy : t -> string -> (unit, write_error) Pervasives.result io
val stat : t -> string -> (Mirage_fs.stat, error) Pervasives.result io
val listdir : t -> string -> (string list, error) Pervasives.result io
val write : t -> string -> int -> page_aligned_buffer -> (unit, write_error) Pervasives.result io
val connect : string -> t Lwt.t