oneffs
  1. Overview
  2. Docs
package oneffs
Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module B : Mirage_block.S

Signature

type t
type error = [
  1. | `Block of B.error
  2. | `Bad_checksum
]
type write_error = B.write_error
val pp_error : error Fmt.t
val pp_write_error : write_error Fmt.t
val write : t -> string -> (unit, write_error) result Lwt.t

write fs data stores data. An error is returned if writing to the underlying block device fails.

val read : t -> (string option, error) result Lwt.t

read fs reads the data stored if any. An error is returned if the checksum is bad or if the read fails.

val is_set : t -> bool

is_set fs is true if fs has any data.

val reset : t -> (unit, write_error) result Lwt.t

reset fs sets fs to no data.

val format : B.t -> (unit, write_error) result Lwt.t

format b writes an empty header at the beginning of b. Note that this is destructive.

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