Skip to main content

SharedVmoIoRequest

fidl_fuchsia_hardware_sharedmemory

Enum SharedVmoIoRequest

pub enum SharedVmoIoRequest {
    Transmit {
        buffer: SharedVmoBuffer,
        responder: SharedVmoIoTransmitResponder,
    },
    Receive {
        buffer: SharedVmoBuffer,
        responder: SharedVmoIoReceiveResponder,
    },
    Exchange {
        tx_buffer: SharedVmoBuffer,
        rx_buffer: SharedVmoBuffer,
        responder: SharedVmoIoExchangeResponder,
    },
}

Expand description

This is a generic protocol for driver IO using shared VMOs. Drivers may compose this protocol and choose which methods to implement based on the uses of the hardware. This protocol is only intended for simple use cases.

Variants§

Transmit

Sends the data in buffer to the device.

Fields

§buffer: SharedVmoBuffer

§responder: SharedVmoIoTransmitResponder

Receive

Receives data from the device into buffer.

Fields

§buffer: SharedVmoBuffer

§responder: SharedVmoIoReceiveResponder

Exchange

Simultaneously transmits and receives data. The size fields of tx_buffer and rx_buffer must be the same.

Fields

§tx_buffer: SharedVmoBuffer

§rx_buffer: SharedVmoBuffer

§responder: SharedVmoIoExchangeResponder

Implementations§

impl SharedVmoIoRequest

pub fn into_transmit( self, ) -> Option<(SharedVmoBuffer, SharedVmoIoTransmitResponder)>

pub fn into_receive( self, ) -> Option<(SharedVmoBuffer, SharedVmoIoReceiveResponder)>

pub fn into_exchange( self, ) -> Option<(SharedVmoBuffer, SharedVmoBuffer, SharedVmoIoExchangeResponder)>

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

Name of the method defined in FIDL

Trait Implementations§

impl Debug for SharedVmoIoRequest

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl !RefUnwindSafe for SharedVmoIoRequest

impl !UnwindSafe for SharedVmoIoRequest

impl Freeze for SharedVmoIoRequest

impl Send for SharedVmoIoRequest

impl Sync for SharedVmoIoRequest

impl Unpin for SharedVmoIoRequest

impl UnsafeUnpin for SharedVmoIoRequest

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T, D> Encode<Ambiguous1, D> for T
where D: ResourceDialect,

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more

impl<T, D> Encode<Ambiguous2, D> for T
where D: ResourceDialect,

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.