Struct fidl_fuchsia_hardware_block_volume::VolumeProxy

pub struct VolumeProxy { /* private fields */ }

Implementations

impl VolumeProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.hardware.block.volume/Volume.

pub fn take_event_stream(&self) -> VolumeEventStream

Get a Stream of events from the remote end of the protocol.

Panics

Panics if the event stream was already taken.

pub fn get_info(&self) -> QueryResponseFut<BlockGetInfoResult>

Get information about the underlying block device.

pub fn get_stats(&self, clear: bool) -> QueryResponseFut<BlockGetStatsResult>

Returns stats about block device operations. Setting clear will reset stats counters.

pub fn open_session( &self, session: ServerEnd<SessionMarker> ) -> Result<(), Error>

Opens a new FIFO-based session on the block device.

pub fn read_blocks( &self, vmo: Vmo, length: u64, dev_offset: u64, vmo_offset: u64 ) -> QueryResponseFut<BlockReadBlocksResult>

Reads from a block device.

This read does not require exclusive access. length, dev_offset and vmo_offset are specified in bytes, but they must be block-aligned. This method is provided for backward compatibility, and is not intended for new code. New code should use the FIFO interface along with the client libraries to read and write from block devices.

pub fn write_blocks( &self, vmo: Vmo, length: u64, dev_offset: u64, vmo_offset: u64 ) -> QueryResponseFut<BlockWriteBlocksResult>

Writes to a block device.

This write does not require exclusive access. length, dev_offset and vmo_offset are specified in bytes, but they must be block-aligned. This method is provided for backward compatibility, and is not intended for new code. New code should use the FIFO interface along with the client libraries to read and write from block devices.

pub fn get_type_guid(&self) -> QueryResponseFut<(i32, Option<Box<Guid>>)>

Gets the type GUID of the partition (if one exists). If the partition has no type GUID, ZX_ERR_NOT_SUPPORTED is returned.

pub fn get_instance_guid(&self) -> QueryResponseFut<(i32, Option<Box<Guid>>)>

Gets the instance GUID of the partition (if one exists). If the partition has no instance GUID, ZX_ERR_NOT_SUPPORTED is returned.

pub fn get_name(&self) -> QueryResponseFut<(i32, Option<String>)>

Gets the name of the partition (if one exists). If the partition has no name, ZX_ERR_NOT_SUPPORTED is returned.

pub fn query_slices( &self, start_slices: &[u64] ) -> QueryResponseFut<(i32, [VsliceRange; 16], u64)>

Returns the number of contiguous allocated (or unallocated) vslices starting from each vslice.

pub fn get_volume_info( &self ) -> QueryResponseFut<(i32, Option<Box<VolumeManagerInfo>>, Option<Box<VolumeInfo>>)>

Returns the information about this volume and the volume manager it is embedded in.

pub fn extend( &self, start_slice: u64, slice_count: u64 ) -> QueryResponseFut<i32>

Extends the mapping of this partition.

The ability to extend the partition is dependent on having sufficient free space on the underlying device, having sufficient free slots for tracking the bytes in the volume manager header, and the partition limit (see VolumeManager.SetPartitionLimit).

pub fn shrink( &self, start_slice: u64, slice_count: u64 ) -> QueryResponseFut<i32>

Shrinks a virtual partition. Returns ZX_OK if ANY slices are freed, even if part of the requested range contains unallocated slices.

pub fn destroy(&self) -> QueryResponseFut<i32>

Destroys the current partition, removing it from the VolumeManager, and freeing all underlying storage. The connection to the volume is also closed.

Trait Implementations

impl Clone for VolumeProxy

fn clone(&self) -> VolumeProxy

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VolumeProxy

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Proxy for VolumeProxy

type Protocol = VolumeMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, Handle>>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.

impl VolumeProxyInterface for VolumeProxy

type GetInfoResponseFut = QueryResponseFut<Result<BlockInfo, i32>>

fn get_info(&self) -> Self::GetInfoResponseFut

type GetStatsResponseFut = QueryResponseFut<Result<BlockStats, i32>>

fn get_stats(&self, clear: bool) -> Self::GetStatsResponseFut

fn open_session(&self, session: ServerEnd<SessionMarker>) -> Result<(), Error>

type ReadBlocksResponseFut = QueryResponseFut<Result<(), i32>>

fn read_blocks( &self, vmo: Vmo, length: u64, dev_offset: u64, vmo_offset: u64 ) -> Self::ReadBlocksResponseFut

type WriteBlocksResponseFut = QueryResponseFut<Result<(), i32>>

fn write_blocks( &self, vmo: Vmo, length: u64, dev_offset: u64, vmo_offset: u64 ) -> Self::WriteBlocksResponseFut

type GetTypeGuidResponseFut = QueryResponseFut<(i32, Option<Box<Guid>>)>

fn get_type_guid(&self) -> Self::GetTypeGuidResponseFut

type GetInstanceGuidResponseFut = QueryResponseFut<(i32, Option<Box<Guid>>)>

fn get_instance_guid(&self) -> Self::GetInstanceGuidResponseFut

type GetNameResponseFut = QueryResponseFut<(i32, Option<String>)>

fn get_name(&self) -> Self::GetNameResponseFut

type QuerySlicesResponseFut = QueryResponseFut<(i32, [VsliceRange; 16], u64)>

fn query_slices(&self, start_slices: &[u64]) -> Self::QuerySlicesResponseFut

type GetVolumeInfoResponseFut = QueryResponseFut<(i32, Option<Box<VolumeManagerInfo>>, Option<Box<VolumeInfo>>)>

fn get_volume_info(&self) -> Self::GetVolumeInfoResponseFut

type ExtendResponseFut = QueryResponseFut<i32>

fn extend(&self, start_slice: u64, slice_count: u64) -> Self::ExtendResponseFut

type ShrinkResponseFut = QueryResponseFut<i32>

fn shrink(&self, start_slice: u64, slice_count: u64) -> Self::ShrinkResponseFut

type DestroyResponseFut = QueryResponseFut<i32>

fn destroy(&self) -> Self::DestroyResponseFut