Struct RingBufferConstraints

#[repr(C)]
pub struct RingBufferConstraints {
    pub min_frames: u32,
    pub max_frames: u32,
    pub modulo_frames: u32,
}

Set restrictions for the device ring buffer. This must be called before calling Add(), or after Remove(). Once the device is activated, the ring buffer and its size are returned by the driver in response to an AUDIO_RB_CMD_GET_BUFFER command on the ring buffer channel. Note: both min_frames and max_frames must be multiples of modulo_frames.

Fields

min_frames: u32

The ring buffer must have at least this many frames. Must be a multiple of modulo_frames.

max_frames: u32

The ring buffer can have at most this many frames. Must be a multiple of modulo_frames.

modulo_frames: u32

The ring buffer must have a multiple of this many frames. Cannot be zero.

Trait Implementations

impl Clone for RingBufferConstraints

fn clone(&self) -> RingBufferConstraints

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RingBufferConstraints

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

Formats the value using the given formatter.

impl<D> Decode<RingBufferConstraints, D> for RingBufferConstraints

where D: ResourceDialect,

fn new_empty() -> RingBufferConstraints

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<(), Error>

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

impl<D> Encode<RingBufferConstraints, D> for &RingBufferConstraints

where D: ResourceDialect,

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

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

impl Hash for RingBufferConstraints

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for RingBufferConstraints

fn cmp(&self, other: &RingBufferConstraints) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for RingBufferConstraints

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

fn partial_cmp(&self, other: &RingBufferConstraints) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TypeMarker for RingBufferConstraints

type Owned = RingBufferConstraints

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 RingBufferConstraints

type Borrowed<'a> = &'a RingBufferConstraints

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: &<RingBufferConstraints as TypeMarker>::Owned, ) -> <RingBufferConstraints as ValueTypeMarker>::Borrowed<'_>

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

impl Copy for RingBufferConstraints

impl Eq for RingBufferConstraints

impl Persistable for RingBufferConstraints

impl StructuralPartialEq for RingBufferConstraints