Module type `Mirage_fs.S`Source

Filesystem

Sourcetype error = private [>

| `Is_a_directory
| `No_directory_entry
| `Not_a_directory

]

The type for errors.

Sourceval pp_error : error Fmt.t

pp_error is the pretty-printer for errors.

Sourcetype write_error = private [>

| `Is_a_directory
| `No_directory_entry
| `Not_a_directory
| `File_already_exists
| `No_directory_entry
| `No_space

]

The type for FS write errors.

Sourceval pp_write_error : write_error Fmt.t

pp_write_error is the pretty-printer for write errors.

include Mirage_device.S

Sourcetype +'a io

The type for potentially blocking I/O operation

Sourcetype t

The type representing the internal state of the device

Sourceval disconnect : t -> unit io

Disconnect from the device. While this might take some time to complete, it can never result in an error.

Sourcetype page_aligned_buffer

The type for memory buffers.

Source

val read : 
  t ->
  string ->
  int ->
  int ->
  (page_aligned_buffer list, error) result io

read t key offset length reads up to length bytes from the value associated with key. If less data is returned than requested, this indicates the end of the value.

Sourceval size : t -> string -> (int64, error) result io

Get the value size.

Sourceval create : t -> string -> (unit, write_error) result io

create t path creates an empty file at path. If path contains directories that do not yet exist, create will attempt to create them.

Sourceval mkdir : t -> string -> (unit, write_error) result io

mkdir t path creates an empty directory at path. If path contains intermediate directories that do not yet exist, mkdir will create them. If a directory already exists at path, mkdir returns `Ok () and takes no action.

Sourceval destroy : t -> string -> (unit, write_error) result io

destroy t path removes a path (which may be a file or an empty directory) on filesystem t.

Sourceval stat : t -> string -> (stat, error) result io

stat t path returns information about file or directory at path.

Sourceval listdir : t -> string -> (string list, error) result io

listdir t path returns the names of files and subdirectories within the directory path.

Source

val write : 
  t ->
  string ->
  int ->
  page_aligned_buffer ->
  (unit, write_error) result io

write t path offset data writes data at offset in file path on filesystem t.

If path contains directories that do not exist, write will attempt to create them. If path already exists, write will overwrite existing information starting at off.

package mirage-fs

Module type Mirage_fs.SSource

Filesystem

Module type `Mirage_fs.S`Source