package mirage-fs-unix

You can search for identifiers within the package.

in-package search v0.2.0

mirage-fs-unix
- FS_unix
- Kvro_fs_unix

Legend:
Library
Module
Module type
Parameter
Class
Class type

include V1.KV_RO
  with type id = string
   and type +'a io = 'a Lwt.t
   and type page_aligned_buffer = Cstruct.t

type error =

| Unknown_key of string

include V1.DEVICE
  with type error := error
  with type id = string
  with type +'a io = 'a Lwt.t

type +'a io = 'a Lwt.t

The type for potentially blocking I/O operation

type t

The type representing the internal state of the device

type id = string

This type is no longer used and will be removed once other * modules stop using it in their type signatures.

val disconnect : t -> unit io

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

type page_aligned_buffer = Cstruct.t

The type for memory buffers.

val read : 
  t ->
  string ->
  int ->
  int ->
  [ `Ok of page_aligned_buffer list | `Error of error ] 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.

val size : t -> string -> [ `Error of error | `Ok of int64 ] io

Get the value size.

val connect : string -> [ `Ok of t | `Error of error ] io