Struct StreamBufferPartialSettings

pub struct StreamBufferPartialSettings {
    pub buffer_lifetime_ordinal: Option<u64>,
    pub buffer_constraints_version_ordinal: Option<u64>,
    pub single_buffer_mode: Option<bool>,
    pub packet_count_for_server: Option<u32>,
    pub packet_count_for_client: Option<u32>,
    pub sysmem_token: Option<ClientEnd<BufferCollectionTokenMarker>>,
    pub sysmem2_token: Option<ClientEnd<BufferCollectionTokenMarker>>,
    /* private fields */
}

Fields

buffer_lifetime_ordinal: Option<u64>

The containing message starts a new buffer_lifetime_ordinal.

There is a separate buffer_lifetime_ordinal for input vs. output.

Re-use of the same value is not allowed. Values must be odd. Values must only increase (increasing by more than 2 is permitted).

A buffer_lifetime_ordinal lifetime starts at SetInputBufferSettings() or SetOutputBufferSettings(), and ends at the earlier of CloseCurrentStream() with release_input_buffers/release_output_buffers set or SetOutputBufferSettings() with new buffer_lifetime_ordinal in the case of mid-stream output config change.

buffer_constraints_version_ordinal: Option<u64>

This value indicates which version of constraints the client is/was aware of so far.

For input, this must always be 0 because constraints don’t change for input (settings can change, but there’s no settings vs current constraints synchronization issue on input).

For output, this allows the server to know when the client is sufficiently caught up before the server will generate any more output.

When there is no active stream, a client is permitted to re-configure buffers again using the same buffer_constraints_version_ordinal.

single_buffer_mode: Option<bool>

packet_count_for_server: Option<u32>

packet_count_for_client: Option<u32>

sysmem_token: Option<ClientEnd<BufferCollectionTokenMarker>>

sysmem2_token: Option<ClientEnd<BufferCollectionTokenMarker>>

The client end of a BufferCollectionToken channel, which the StreamProcessor will use to deliver constraints to sysmem and learn of buffers allocated by sysmem.

The client guarantees that the token is already known to sysmem (via BufferCollectionToken.Sync(), BufferCollection.Sync(), or BufferCollectionEvents.OnDuplicatedTokensKnownByServer()).

Trait Implementations

impl Debug for StreamBufferPartialSettings

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

Formats the value using the given formatter.

impl Decode<StreamBufferPartialSettings, DefaultFuchsiaResourceDialect> for StreamBufferPartialSettings

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<'_, DefaultFuchsiaResourceDialect>, offset: usize, depth: Depth, ) -> Result<()>

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

impl Default for StreamBufferPartialSettings

fn default() -> StreamBufferPartialSettings

Returns the “default value” for a type.

impl Encode<StreamBufferPartialSettings, DefaultFuchsiaResourceDialect> for &mut StreamBufferPartialSettings

unsafe fn encode( self, encoder: &mut Encoder<'_, DefaultFuchsiaResourceDialect>, 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 StreamBufferPartialSettings

fn eq(&self, other: &StreamBufferPartialSettings) -> 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 StreamBufferPartialSettings

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

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 StreamBufferPartialSettings

type Owned = StreamBufferPartialSettings

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<DefaultFuchsiaResourceDialect> for StreamBufferPartialSettings

impl StructuralPartialEq for StreamBufferPartialSettings