On This Page
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package mirage-block-partition
Parameters
module B : Mirage_block.SSignature
include Mirage_block.S
with type error = [ Mirage_block.error | `Block of B.error | `Out_of_bounds ]
and type write_error =
[ Mirage_block.write_error
| `Block of B.write_error
| `Out_of_bounds ]
The type for block errors.
val pp_error : error Fmt.tpp_error is the pretty-printer for errors.
The type for write errors.
val pp_write_error : write_error Fmt.tpp_write_error is the pretty-printer for write errors.
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.tQuery the characteristics of a specific block device
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.twrite 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.
subpartition ~start ~len t is Ok t' where t' is the sub partition of t starting at start relative to t with len sectors, or Error
`Out_of_bounds if subpartition is outside t.
val get_offset : t -> int64get_offset b is the sector offset of the partition relative to the underlying block device.
On This Page