Struct RingBufferProperties

pub struct RingBufferProperties {
    pub valid_bits_per_sample: Option<u8>,
    pub turn_on_delay: Option<i64>,
    /* private fields */
}

Information about the ring buffer or associated audio stream.

Fields

valid_bits_per_sample: Option<u8>

The number of bits (starting with the most significant) that are valid, within each individual sample. This may be be smaller than the actual sample size, in the case of an input ring buffer fed by an 18-bit ADC for example. Any additional bits of precision should be ignored.

Required.

turn_on_delay: Option<i64>

The maximum delay until disabled channels become fully operational, after calling SetActiveChannels. This is the worst-case duration when reenabling all channels. The value must be non-negative.

Required.

Trait Implementations

impl Clone for RingBufferProperties

fn clone(&self) -> RingBufferProperties

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RingBufferProperties

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

Formats the value using the given formatter.

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

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 RingBufferProperties

fn default() -> RingBufferProperties

Returns the “default value” for a type.

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

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 RingBufferProperties

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

type Owned = RingBufferProperties

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 RingBufferProperties

type Borrowed<'a> = &'a RingBufferProperties

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 RingBufferProperties

impl StructuralPartialEq for RingBufferProperties