Page
Library
Module
Module type
Parameter
Class
Class type
Source
Mirage_fs.S
SourceThe type for errors.
type 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.
pp_write_error
is the pretty-printer for write errors.
The type representing the internal state of the file system.
Disconnect from the file system. While this might take some time to complete, it can never result in an error.
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.
create t path
creates an empty file at path
. If path
contains directories that do not yet exist, create
will attempt to create them.
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.
destroy t path
removes a path
(which may be a file or an empty directory) on filesystem t
.
stat t path
returns information about file or directory at path
.
listdir t path
returns the names of files and subdirectories within the directory path
.
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
.