package tar-mirage

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package tar-mirage

tar-mirage
- Tar_mirage
  - Make_KV_RO
    
    BLOCK

Legend:
Library
Module
Module type
Parameter
Class
Class type

Construct a read-only key-value store from an existing block device containing tar-format data.

Parameters

module BLOCK : Mirage_block_lwt.S

Signature

include Mirage_types_lwt.KV_RO

type 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

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

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) 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) 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) result io

Get the value size.

val connect : BLOCK.t -> t Lwt.t