package tar-format

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package tar-format

tar
- Tar
  - ASYNC
  - Header
    
    Extended
    
    Link
  - HeaderReader
    
    Async
    
    Reader
  - HeaderWriter
    
    Async
    
    Writer
  - IO
  - Make
    
    Archive
    
    Header
    
    Extended
    
    Link
    
    IO
  - READER
  - WRITER
tar.lwt
- Tar_lwt_unix
  - Archive
  - Header
    
    Extended
    
    Link
tar.mirage
- Tar_mirage
  - Make_KV_RO
    
    BLOCK
tar.unix
- Tar_unix
  - Archive
  - Header
    
    Extended
    
    Link

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 : V1_LWT.BLOCK

Signature

include V1_LWT.KV_RO

type error =

| Unknown_key of string

include V1.DEVICE with type error := error 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

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 : BLOCK.t -> [> `Ok of t ] Lwt.t