Struct RingBufferOptions

pub struct RingBufferOptions {
    pub format: Option<Format>,
    pub ring_buffer_min_bytes: Option<u32>,
    /* private fields */
}

Parameters specified by a caller when creating a ring buffer.

Fields

format: Option<Format>

The format (sample format, channelization, frame rate) of the ring buffer to be created.

Required.

ring_buffer_min_bytes: Option<u32>

The minimum number of bytes required in the ring buffer. The actual buffer may be larger, as required by the encoding, driver, device or OS.

Required.

Trait Implementations

impl Clone for RingBufferOptions

fn clone(&self) -> RingBufferOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RingBufferOptions

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

Formats the value using the given formatter.

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

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 RingBufferOptions

fn default() -> RingBufferOptions

Returns the “default value” for a type.

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

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 RingBufferOptions

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

type Owned = RingBufferOptions

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 RingBufferOptions

type Borrowed<'a> = &'a RingBufferOptions

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 RingBufferOptions

impl StructuralPartialEq for RingBufferOptions