package mirage-block-xen
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=03376069972d05cfa4daeb89a934faef43cfdb583838e575cbeb662bebdef451
sha512=8288e1f0e08875e5dc9a5a13c39bfd495fc0571645fa13bf6d218ff7c34e90fd665c00ebecf688e5c110c889ff1fabeae317ecf4ca975a5d05cbcc5c219a675d
doc/mirage-block-xen.front/Block/index.html
Module Block
Source
include module type of struct include Blkfront end
include Mirage_block.S
The type for block errors.
The type for write errors.
pp_write_error
is the pretty-printer for write errors.
The type representing the internal state of the block device
Disconnect from the device. While this might take some time to complete, it can never result in an error.
Query 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.
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.