Struct StreamProcessorRemoveBufferRequest 

pub struct StreamProcessorRemoveBufferRequest {
    pub port: Option<Port>,
    pub buffer_lifetime_ordinal: Option<u64>,
    pub buffer_index: Option<u32>,
    /* private fields */
}

Fields

port: Option<Port>

Must be set. Which port (input or output) the buffer is for.

buffer_lifetime_ordinal: Option<u64>

Scoped to input or output, this is the buffer_lifetime_ordinal under which the buffer_index is meaningful.

buffer_index: Option<u32>

The buffer_index of the buffer previously established (and most recently established) by AddBuffer, or by SetInputBufferPartialSettings / SetOutputBufferPartialSettings. The scope of this value is under input vs. output and under the buffer_lifetime_ordinal value.

When using dynamic buffers, the buffer_index values that are between AddBuffer starting and RemoveBuffer completing (the active buffer_index values) must be unique for a given Port value and buffer_lifetime_ordinal value.

Clients using dynamic buffers may wish to not re-use a buffer_index value quickly upon completion of RemoveBuffer just to make debugging/diagnosing easier, but technically re-use of buffer_index in a subsequent AddBuffer is permitted as soon as RemoveBuffer completes (from the StreamProcessor point of view - the client may have its own reasons to not re-use that quickly). AddBuffer under an old (not current) buffer_lifetime_ordinal is never allowed.

Trait Implementations

impl Debug for StreamProcessorRemoveBufferRequest

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

Formats the value using the given formatter.

impl Decode<StreamProcessorRemoveBufferRequest, FDomainResourceDialect> for StreamProcessorRemoveBufferRequest

fn new_empty() -> Self

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_, FDomainResourceDialect>, offset: usize, depth: Depth, ) -> Result<()>

Decodes an object of type T from the decoder’s buffers into self.

impl Default for StreamProcessorRemoveBufferRequest

fn default() -> StreamProcessorRemoveBufferRequest

Returns the “default value” for a type.

impl Encode<StreamProcessorRemoveBufferRequest, FDomainResourceDialect> for &mut StreamProcessorRemoveBufferRequest

unsafe fn encode( self, encoder: &mut Encoder<'_, FDomainResourceDialect>, offset: usize, depth: Depth, ) -> Result<()>

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

impl PartialEq for StreamProcessorRemoveBufferRequest

fn eq(&self, other: &StreamProcessorRemoveBufferRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ResourceTypeMarker for StreamProcessorRemoveBufferRequest

type Borrowed<'a> = &'a mut StreamProcessorRemoveBufferRequest

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &mut Self::Owned. There are three cases:

fn take_or_borrow<'a>( value: &'a mut <Self as TypeMarker>::Owned, ) -> Self::Borrowed<'a>

Cheaply converts from &mut Self::Owned to Self::Borrowed. For HandleBased types this is “take” (it returns an owned handle and replaces value with Handle::invalid), and for all other types it is “borrow” (just converts from one reference to another).

impl TypeMarker for StreamProcessorRemoveBufferRequest

type Owned = StreamProcessorRemoveBufferRequest

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl Standalone<FDomainResourceDialect> for StreamProcessorRemoveBufferRequest

impl StructuralPartialEq for StreamProcessorRemoveBufferRequest