Enum BlockRequest

pub enum BlockRequest {
    GetInfo {
        responder: BlockGetInfoResponder,
    },
    GetStats {
        clear: bool,
        responder: BlockGetStatsResponder,
    },
    OpenSession {
        session: ServerEnd<SessionMarker>,
        control_handle: BlockControlHandle,
    },
    OpenSessionWithOffsetMap {
        session: ServerEnd<SessionMarker>,
        offset_map: Option<ClientEnd<OffsetMapMarker>>,
        initial_mappings: Option<Vec<BlockOffsetMapping>>,
        control_handle: BlockControlHandle,
    },
}

Defines access to a device which is accessible in block-granularity chunks for reading and writing.

Variants

GetInfo

Get information about the underlying block device.

Fields

responder: BlockGetInfoResponder

GetStats

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

Fields

clear: bool

responder: BlockGetStatsResponder

OpenSession

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

Fields

session: ServerEnd<SessionMarker>

control_handle: BlockControlHandle

OpenSessionWithOffsetMap

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.

Fields

session: ServerEnd<SessionMarker>

offset_map: Option<ClientEnd<OffsetMapMarker>>

initial_mappings: Option<Vec<BlockOffsetMapping>>

control_handle: BlockControlHandle

Implementations

impl BlockRequest

pub fn into_get_info(self) -> Option<BlockGetInfoResponder>

pub fn into_get_stats(self) -> Option<(bool, BlockGetStatsResponder)>

pub fn into_open_session( self, ) -> Option<(ServerEnd<SessionMarker>, BlockControlHandle)>

pub fn into_open_session_with_offset_map( self, ) -> Option<(ServerEnd<SessionMarker>, Option<ClientEnd<OffsetMapMarker>>, Option<Vec<BlockOffsetMapping>>, BlockControlHandle)>

pub fn method_name(&self) -> &'static str

Name of the method defined in FIDL

Trait Implementations

impl Debug for BlockRequest

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

Formats the value using the given formatter.