package mirage-block-combinators

  1. Overview
  2. Docs

Parameters

module B : Mirage_block.S

Signature

type t = B.t
type error = [
  1. | Mirage_block.error
  2. | `Unsafe of string
  3. | `Private of B.error
]
val pp_error : Stdlib.Format.formatter -> [< `Disconnected | `Private of B.error | `Unsafe of string ] -> unit
type write_error = [
  1. | Mirage_block.write_error
  2. | `Unsafe of string
  3. | `Private of B.write_error
]
val pp_write_error : Stdlib.Format.formatter -> [< `Disconnected | `Is_read_only | `Private of B.write_error | `Unsafe of string ] -> unit
val get_info : B.t -> Mirage_block.info Lwt.t
val disconnect : B.t -> unit Lwt.t
val lift_error : ('a, [> Mirage_block.error ] as 'b) Stdlib.result -> ('c, [> `Disconnected | `Private of 'd ]) Stdlib.result
val lift_write_error : ('a, [> Mirage_block.write_error ] as 'b) Stdlib.result -> ('c, [> `Disconnected | `Is_read_only | `Private of 'd ]) Stdlib.result
val (>>*=) : ('a, 'b) Stdlib.result Lwt.t -> ('c -> ('d, 'e) Stdlib.result Lwt.t) -> ('d, 'e) Stdlib.result Lwt.t
val fatalf : ('a, unit, string, ('b, [> `Unsafe of string ]) Stdlib.result Lwt.t) Stdlib.format4 -> 'c
val check_buffer : string -> int -> Cstruct.t -> (unit, [> `Unsafe of string ]) Stdlib.result Lwt.t
val check_buffers : string -> int -> Cstruct.t list -> (unit, [> `Unsafe of string ]) Stdlib.result Lwt.t
val check_in_range : string -> int64 -> int64 -> (unit, [> `Unsafe of string ]) Stdlib.result Lwt.t
val check : string -> int -> int64 -> int64 -> Cstruct.t list -> (unit, [> `Unsafe of string ]) Stdlib.result Lwt.t
val unsafe_read : B.t -> int64 -> Cstruct.t list -> (unit, B.error) Stdlib.result Lwt.t
val unsafe_write : B.t -> int64 -> Cstruct.t list -> (unit, B.write_error) Stdlib.result Lwt.t
val read : B.t -> int64 -> Cstruct.t list -> (unit, [> `Disconnected | `Private of B.error | `Unsafe of string ]) Stdlib.result Lwt.t
val write : B.t -> int64 -> Cstruct.t list -> (unit, [> `Disconnected | `Is_read_only | `Private of B.write_error | `Unsafe of string ]) Stdlib.result Lwt.t