package mirage-block-lwt

You can search for identifiers within the package.

in-package search v0.2.0

Legend:
Library
Module
Module type
Parameter
Class
Class type

include S

type page_aligned_buffer = Cstruct.t

type error = private [>

]

val pp_error : error Fmt.t

type write_error = private [>

]

val pp_write_error : write_error Fmt.t

type 'a io = 'a Lwt.t

type t

val disconnect : t -> unit io

val get_info : t -> Mirage_block.info io

val read : 
  t ->
  int64 ->
  page_aligned_buffer list ->
  (unit, error) Result.result io

val write : 
  t ->
  int64 ->
  page_aligned_buffer list ->
  (unit, write_error) Result.result io

val seek_unmapped : t -> int64 -> (int64, error) Result.result io

seek_unmapped t start returns the sector offset of the next guaranteed zero-filled region (typically guaranteed because it is unmapped)

val seek_mapped : t -> int64 -> (int64, error) Result.result io

seek_mapped t start returns the sector offset of the next regoin of the device which may have data in it (typically this is the next mapped region)