package mirage-block-partition

  1. Overview
  2. Docs
Mirage block device partitioning

Install

Dune Dependency

Authors

Maintainers

Sources

mirage-block-partition-0.2.0.tbz
sha256=7173ad10ff70864846423ebd4f868a7b16e67ba85f54056a0c56bd91fe960171
sha512=665726cfe861c3de311a61591a03574e512f36ba81193451bece340b022e0a1b9a1a492132a1ae722c3439c44689a22763a83b5a9bb0dd8079c2ca5c4cdc249a

doc/mirage-block-partition.mbr/Mirage_block_partition_mbr/Make/index.html

Module Mirage_block_partition_mbr.MakeSource

Parameters

module B : Mirage_block.S

Signature

include Mirage_block.S
Sourcetype nonrec error = private [>
  1. | Mirage_block.error
]

The type for block errors.

Sourceval pp_error : error Fmt.t

pp_error is the pretty-printer for errors.

Sourcetype nonrec write_error = private [>
  1. | Mirage_block.write_error
]

The type for write errors.

Sourceval pp_write_error : write_error Fmt.t

pp_write_error is the pretty-printer for write errors.

Sourcetype t

The type representing the internal state of the block device

Sourceval disconnect : t -> unit Lwt.t

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

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

Query the characteristics of a specific block device

Sourceval read : t -> int64 -> Cstruct.t list -> (unit, error) 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.

Sourceval write : t -> int64 -> Cstruct.t list -> (unit, write_error) 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.

Sourceval connect : B.t -> ((Mbr.Partition.t * t) list, error) result Lwt.t

connect b returns a pair of Mbr.Partition.t from the MBR and a corresponding device representing the partition. An error is returned if any of the partitions are outside the device.

  • raises Failure

    if reading the MBR fails or does not parse.

OCaml

Innovation. Community. Security.