Skip to main content

RecvChain

Struct RecvChain 

Source
pub struct RecvChain<M: MemOps> { /* private fields */ }
Expand description

Stateful reader over device-readable descriptors received from the producer.

Reads copy directly from shared memory into caller-provided final storage. The chain must be returned together with its paired ReplyChain through VirtqConsumer::complete before the descriptors can be reused.

Implementations§

Source§

impl<M: MemOps> RecvChain<M>

Source

pub fn token(&self) -> Token

The token identifying this chain.

Source

pub fn len(&self) -> usize

Total readable payload length.

Source

pub fn is_empty(&self) -> bool

Whether this chain has no readable payload.

Source

pub fn consumed(&self) -> usize

Number of bytes consumed by the stateful reader.

Source

pub fn remaining(&self) -> usize

Number of bytes still available to the stateful reader.

Source

pub fn read(&mut self, buf: &mut [u8]) -> Result<usize, VirtqError>

Read bytes sequentially across descriptor boundaries.

Returns the number of bytes copied, which may be smaller than buf.len() at the end of the chain. If a later memory read fails, the cursor remains advanced past any earlier chunks copied by the same call.

Source

pub fn read_exact(&mut self, buf: &mut [u8]) -> Result<&mut Self, VirtqError>

Read exactly buf.len() bytes or return an error.

Source

pub fn to_segments(&self) -> Result<Segments, VirtqError>

Copy the complete payload into descriptor-preserving owned segments.

This does not change the stateful read position. Each call takes a new snapshot of shared memory; callers should validate and use the returned owned value rather than reading the same untrusted payload again.

§Errors

Returns VirtqError::Bookkeeping for allocation failures or VirtqError::MemoryReadError for unreadable payloads.

Source

pub fn to_bytes(&self) -> Result<Bytes, VirtqError>

Copy the complete payload directly into one contiguous allocation.

This does not change the stateful read position. Each call takes a new snapshot of shared memory; callers should validate and use the returned owned value rather than reading the same untrusted payload again.

§Errors

Returns VirtqError::Bookkeeping for allocation failures or VirtqError::MemoryReadError for unreadable payloads.

Trait Implementations§

Source§

impl<M: MemOps> Debug for RecvChain<M>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<M: MemOps> ExternalValueSource for RecvChain<M>

Copies values so later shared-memory writes cannot change decoded arguments.

Source§

fn take_bytes(&mut self, length: usize) -> Result<Vec<u8>>

Take the next external value as contiguous bytes.
Source§

fn take_chunks(&mut self, length: usize) -> Result<Vec<Bytes>>

Take the next external value as owned byte chunks.
Source§

fn finish(&mut self) -> Result<()>

Finish decoding and reject any unused external values.

Auto Trait Implementations§

§

impl<M> Freeze for RecvChain<M>
where ChainState<M>: Freeze,

§

impl<M> RefUnwindSafe for RecvChain<M>
where ChainState<M>: RefUnwindSafe,

§

impl<M> Send for RecvChain<M>
where ChainState<M>: Send,

§

impl<M> Sync for RecvChain<M>
where ChainState<M>: Sync,

§

impl<M> Unpin for RecvChain<M>
where ChainState<M>: Unpin,

§

impl<M> UnsafeUnpin for RecvChain<M>
where ChainState<M>: UnsafeUnpin,

§

impl<M> UnwindSafe for RecvChain<M>
where ChainState<M>: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more