Struct BlockDevice

pub struct BlockDevice { /* private fields */ }

BlockDevice is an implementation of Device backed by a real block device behind a FIFO.

Implementations

impl BlockDevice

pub async fn new( remote: Box<dyn BlockClient>, read_only: bool, ) -> Result<Self, Error>

Creates a new BlockDevice over |remote|.

Trait Implementations

impl Device for BlockDevice

fn allocate_buffer(&self, size: usize) -> BufferFuture<'_>

Allocates a transfer buffer of at least |size| bytes for doing I/O with the device. The actual size of the buffer will be rounded up to a block-aligned size.

fn block_size(&self) -> u32

Returns the block size of the device. Buffers are aligned to block-aligned chunks.

fn block_count(&self) -> u64

Returns the number of blocks of the device.

fn read<'life0, 'life1, 'async_trait>( &'life0 self, offset: u64, buffer: MutableBufferRef<'life1>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Fills |buffer| with blocks read from |offset|.

fn write_with_opts<'life0, 'life1, 'async_trait>( &'life0 self, offset: u64, buffer: BufferRef<'life1>, opts: WriteOptions, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Writes the contents of |buffer| to the device at |offset|.

fn trim<'life0, 'async_trait>( &'life0 self, range: Range<u64>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Trims the given device |range|.

fn close<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Closes the block device. It is an error to continue using the device after this, but close itself is idempotent.

fn flush<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Flush the device.

fn is_read_only(&self) -> bool

Returns whether the device is read-only.

fn supports_trim(&self) -> bool

Returns whether the device supports trim.

fn size(&self) -> u64

Returns the size in bytes of the device.

fn write<'life0, 'life1, 'async_trait>( &'life0 self, offset: u64, buffer: BufferRef<'life1>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Writes the contents of |buffer| to the device at |offset|.

fn reopen(&self, _read_only: bool)

Reopens the device, making it usable again. (Only implemented for testing devices.)

fn snapshot(&self) -> Result<DeviceHolder, Error>

Returns a snapshot of the device.

fn discard_random_since_last_flush(&self) -> Result<(), Error>

Discards random blocks since the last flush.

fn poison(&self) -> Result<(), Error>

Poisons a device to panic on drop. Used to find hanging references.

impl Drop for BlockDevice

fn drop(&mut self)

Executes the destructor for this type.