protocol-9p

An implementation of the 9P protocol in pure OCaml
Library protocol_9p
Module Protocol_9p . Client . S . KV_RO
type error#row

The type for errors.

and error = private [>
| `Unknown_key of string
]

The type for errors.

val pp_error : error Fmt.t

pp_error is the pretty-printer for errors.

include Mirage_device.S with type 'a io = 'a Lwt.t with type t = t
type 'a io = 'a Lwt.t

The type for potentially blocking I/O operation

type t = t

The type representing the internal state of the device

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 -> int64 -> int64 -> ( page_aligned_buffer list, error ) Pervasives.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.

val mem : t -> string -> ( bool, error ) Pervasives.result io

mem t key returns true if a value is set for key in t, and false if not so.

val size : t -> string -> ( int64, error ) Pervasives.result io

Get the value size.