Struct RingBuffer

pub struct RingBuffer {
    pub driver_transfer_bytes: Option<u32>,
    pub internal_delay: Option<i64>,
    pub external_delay: Option<i64>,
    pub supported_formats: Option<Vec<FormatRange>>,
    pub ring_buffer_constraints: Option<RingBufferConstraints>,
    pub notifications_per_ring: Option<u32>,
    /* private fields */
}

Configuration for a fuchsia.hardware.audio/RingBuffer.

Fields

driver_transfer_bytes: Option<u32>

Driver transfer bytes.

Optional.

internal_delay: Option<i64>

Internal delay.

Optional.

external_delay: Option<i64>

External delay.

Optional.

supported_formats: Option<Vec<FormatRange>>

Supported ring buffer format ranges for this ring buffer.

Required.

ring_buffer_constraints: Option<RingBufferConstraints>

Constraints on the ring buffer. If unspecified, there are no constraints.

Optional.

notifications_per_ring: Option<u32>

Notification frequency. This can be changed later with SetNotificationFrequency. If unspecified, the notification frequency will be the same as that specified by the client when retrieving the RingBuffer VMO.

Optional.

Trait Implementations

impl Clone for RingBuffer

fn clone(&self) -> RingBuffer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RingBuffer

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

Formats the value using the given formatter.

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

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 RingBuffer

fn default() -> RingBuffer

Returns the “default value” for a type.

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

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 RingBuffer

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

type Owned = RingBuffer

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 RingBuffer

type Borrowed<'a> = &'a RingBuffer

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 RingBuffer

impl StructuralPartialEq for RingBuffer