Struct fidl_fuchsia_hardware_audio::PcmSupportedFormats

pub struct PcmSupportedFormats {
    pub channel_sets: Option<Vec<ChannelSet>>,
    pub sample_formats: Option<Vec<SampleFormat>>,
    pub bytes_per_sample: Option<Vec<u8>>,
    pub valid_bits_per_sample: Option<Vec<u8>>,
    pub frame_rates: Option<Vec<u32>>,
    /* private fields */
}

Format supporting non-compressed PCM audio. Each frame consists of one or more (number_of_channels) samples, stored contiguously. Within the bytes_per_sample allocated for each sample, valid_bits_per_sample bits of data are stored in the most-significant (left-justified) portion. All values listed in each vector are supported. When not all combinations supported by the driver can be described with one SupportedFormats or PcmSupportedFormats, GetSupportedFormats returns more than one SupportedFormats in the returned vector. For more detailed information see Audio Driver Streaming Interface.

Fields

channel_sets: Option<Vec<ChannelSet>>

Vector of possible ChannelSets supported. A ChannelSet specifies a channel configuration (including a channel-count), plus a number of optional attributes. Only one ChannelSet is allowed for each unique channel-count. As a result, no two entries in channel_sets can contain attributes vectors with the same length.

Required.

sample_formats: Option<Vec<SampleFormat>>

Vector of possible SampleFormats supported.

Required.

bytes_per_sample: Option<Vec<u8>>

Vector of possible bytes allocated for each sample. Values must be listed in ascending order. All values listed in valid_bits_per_sample must fit into at least the largest bytes_per_sample value.

Required.

valid_bits_per_sample: Option<Vec<u8>>

Vector of possible number of bits containing valid data, within the sample container defined by bytes_per_sample. Values must be listed in ascending order. All values listed must fit into the largest bytes_per_sample value. The valid data bits must be most-significant (left-justified) within the sample container, and any additional bits will be ignored.

Required.

frame_rates: Option<Vec<u32>>

Vector of possible frame rates supported. Values must be listed in ascending order.

Required.

Trait Implementations

impl Clone for PcmSupportedFormats

fn clone(&self) -> PcmSupportedFormats

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PcmSupportedFormats

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

Formats the value using the given formatter.

impl Decode<PcmSupportedFormats> for PcmSupportedFormats

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

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

impl Default for PcmSupportedFormats

fn default() -> PcmSupportedFormats

Returns the “default value” for a type.

impl Encode<PcmSupportedFormats> for &PcmSupportedFormats

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

fn eq(&self, other: &PcmSupportedFormats) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TypeMarker for PcmSupportedFormats

type Owned = PcmSupportedFormats

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 PcmSupportedFormats

type Borrowed<'a> = &'a PcmSupportedFormats

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<'a>(value: &'a <Self as TypeMarker>::Owned) -> Self::Borrowed<'a>

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

impl Persistable for PcmSupportedFormats

impl StructuralPartialEq for PcmSupportedFormats