Struct StreamBufferConstraints

pub struct StreamBufferConstraints {

    pub buffer_constraints_version_ordinal: Option<u64>,
    pub default_settings: Option<StreamBufferSettings>,
    pub per_packet_buffer_bytes_min: Option<u32>,
    pub per_packet_buffer_bytes_recommended: Option<u32>,
    pub per_packet_buffer_bytes_max: Option<u32>,
    pub packet_count_for_server_min: Option<u32>,
    pub packet_count_for_server_recommended: Option<u32>,
    pub packet_count_for_server_recommended_max: Option<u32>,
    pub packet_count_for_server_max: Option<u32>,
    pub packet_count_for_client_min: Option<u32>,
    pub packet_count_for_client_max: Option<u32>,
    pub single_buffer_mode_allowed: Option<bool>,
    pub is_physically_contiguous_required: Option<bool>,
    /* private fields */
}

This struct conveys the buffer_constraints_version_ordinal.

Historically this table conveyed more fields than it currently does, but those fields are all deprecated in favor of using sysmem instead.

There are separate instances of this struct for stream input and stream output.

Notes about fields:

For uncompressed video, separate and complete frames in their separate buffers (buffer-per-packet mode) are always a requirement.

Fields

buffer_constraints_version_ordinal: Option<u64>

This is a version number the server sets on the constraints to allow the server to determine when the client has caught up with the latest constraints sent by the server. The server won’t emit output data until the client has configured output settings and buffers with a buffer_constraints_version_ordinal >= the latest buffer_constraints_version_ordinal that had buffer_constraints_action_required true. See buffer_constraints_action_required comments for more.

A buffer_constraints_version_ordinal of 0 is not permitted, to simplify initial state handling. Other than 0, both odd and even version ordinals are allowed (in contrast to the stream_lifetime_ordinal, neither the client nor server ever has a reason to consider the latest version to be stale, so there would be no benefit to disallowing even values).

default_settings: Option<StreamBufferSettings>

per_packet_buffer_bytes_min: Option<u32>

per_packet_buffer_bytes_recommended: Option<u32>

per_packet_buffer_bytes_max: Option<u32>

packet_count_for_server_min: Option<u32>

packet_count_for_server_recommended: Option<u32>

packet_count_for_server_recommended_max: Option<u32>

packet_count_for_server_max: Option<u32>

packet_count_for_client_min: Option<u32>

packet_count_for_client_max: Option<u32>

single_buffer_mode_allowed: Option<bool>

is_physically_contiguous_required: Option<bool>

Trait Implementations

impl Clone for StreamBufferConstraints

fn clone(&self) -> StreamBufferConstraints

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StreamBufferConstraints

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

Formats the value using the given formatter.

impl<D: ResourceDialect> Decode<StreamBufferConstraints, D> for StreamBufferConstraints

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

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

impl Default for StreamBufferConstraints

fn default() -> StreamBufferConstraints

Returns the “default value” for a type.

impl<D: ResourceDialect> Encode<StreamBufferConstraints, D> for &StreamBufferConstraints

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

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

type Owned = StreamBufferConstraints

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 ValueTypeMarker for StreamBufferConstraints

type Borrowed<'a> = &'a StreamBufferConstraints

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

fn borrow(value: &<Self as TypeMarker>::Owned) -> Self::Borrowed<'_>

Cheaply converts from &Self::Owned to Self::Borrowed.

impl Persistable for StreamBufferConstraints

impl StructuralPartialEq for StreamBufferConstraints