Struct BlockProxy

pub struct BlockProxy { /* private fields */ }

Implementations

impl BlockProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.hardware.block/Block.

pub fn take_event_stream(&self) -> BlockEventStream

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, DefaultFuchsiaResourceDialect>

Get information about the underlying block device.

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

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 open_session_with_offset_map( &self, session: ServerEnd<SessionMarker>, offset_map: Option<ClientEnd<OffsetMapMarker>>, initial_mappings: Option<&[BlockOffsetMapping]>, ) -> Result<(), Error>

Opens a new FIFO-based session on the block device, providing an offset lookup map which transparently translates device offsets in block FIFO requests.

initial_mappings is a static set of mappings which the server can immediately use. If offset_map is not provided, this must be non-empty, and requests that fall outside of the mapped range will fail.

If offset_map is provided, whenever the server receives a request with a dev_offset that falls outside of the known range, it will consult offset_map to attempt to resolve the offset. Because these offset mappings must be stable for the duration of the session, the server may cache any mappings.

This interface is intended to be used internally between nested Block implementations, in order to provide passthrough I/O. For example, a fixed partition map (e.g. GPT) will serve a Block protocol for each partition, and will respond to OpenSession requests by calling OpenSessionWithOffsetMap on the underlying block device, establishing itself as the source for translating client block offsets (relative to the partition start) to absolute offsets. The client can then communicate directly with the underlying block device, and the partition offsets can be transparently applied to requests.

Trait Implementations

impl BlockProxyInterface for BlockProxy

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

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

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

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

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

fn open_session_with_offset_map( &self, session: ServerEnd<SessionMarker>, offset_map: Option<ClientEnd<OffsetMapMarker>>, initial_mappings: Option<&[BlockOffsetMapping]>, ) -> Result<(), Error>

impl Clone for BlockProxy

fn clone(&self) -> BlockProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlockProxy

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

Formats the value using the given formatter.

impl Proxy for BlockProxy

type Protocol = BlockMarker

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.