package mirage-block-partition

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

mirage-block-partition
- Mirage_block_partition
  - Make
    
    B
mirage-block-partition.mbr
- Mirage_block_partition_mbr
  - Make
    
    B

Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module B : Mirage_block.S

Signature

include Mirage_block.S

type nonrec error = private [>

| Mirage_block.error

]

The type for block errors.

val pp_error : error Fmt.t

pp_error is the pretty-printer for errors.

type nonrec write_error = private [>

| Mirage_block.write_error

]

The type for write errors.

val pp_write_error : write_error Fmt.t

pp_write_error is the pretty-printer for write errors.

type t

The type representing the internal state of the block device

val disconnect : t -> unit Lwt.t

Disconnect from the device. While this might take some time to complete, it can never result in an error.

val get_info : t -> Mirage_block.info Lwt.t

Query the characteristics of a specific block device

val read : t -> int64 -> Cstruct.t list -> (unit, error) Stdlib.result Lwt.t

read device sector_start buffers reads data starting at sector_start from the block device into buffers. Ok () means the buffers have been filled. Error _ indicates an I/O error has happened and some of the buffers may not be filled. Each of elements in the list buffers must be a whole number of sectors in length. The list of buffers can be of any length. Some implementations may further require that each element in buffers is exactly sector_size long.

val write : 
  t ->
  int64 ->
  Cstruct.t list ->
  (unit, write_error) Stdlib.result Lwt.t

write device sector_start buffers writes data from buffers onto the block device starting at sector_start. Ok () means the contents of the buffers have been written. Error _ indicates a partial failure in which some of the writes may not have happened.

Once submitted, it is not possible to cancel a request and there is no timeout.

The operation may fail with: `Is_read_only: the device is read-only, no data has been written.

Each of buffers must be a whole number of sectors in length. The list of buffers can be of any length. Some implementations may further require that each element in buffers is exactly sector_size long.

The data will not be copied, so the supplied buffers must not be re-used until the IO operation completes.

val connect : int64 -> B.t -> (t * t) Lwt.t

connect first_sectors b returns two block device partitions of b with the first partition of first_sectors sectors, and the second partition the remaining space, if any.

raises Invalid_argument
if the partition point is outside the device.

val subpartition : int64 -> t -> t * t

subpartition first_sectors b further partitions a partition into two sub partitions.

raises Invalid_argument
if the partition point is outside the partition.

val get_offset : t -> int64

get_offset b is the sector offset of the partition relative to the underlying block device.