Struct ScoConnectionParameters

pub struct ScoConnectionParameters {
    pub parameter_set: Option<HfpParameterSet>,
    pub air_coding_format: Option<AssignedCodingFormat>,
    pub air_frame_size: Option<u16>,
    pub io_bandwidth: Option<u32>,
    pub io_coding_format: Option<AssignedCodingFormat>,
    pub io_frame_size: Option<u16>,
    pub io_pcm_data_format: Option<SampleFormat>,
    pub io_pcm_sample_payload_msb_position: Option<u8>,
    pub path: Option<DataPath>,
    pub max_tx_data_size: Option<u16>,
    /* private fields */
}

Fields

parameter_set: Option<HfpParameterSet>

Set of SCO parameters from the Hands-Free Profile specification. Required.

air_coding_format: Option<AssignedCodingFormat>

The over-the-air coding format used for transmitted and received data. Required.

air_frame_size: Option<u16>

Frame size produced by the codec in the context of over-the-air coding. Required.

io_bandwidth: Option<u32>

Host-controller data rate in bytes/second. Required.

io_coding_format: Option<AssignedCodingFormat>

The coding format used over the transport. Required.

io_frame_size: Option<u16>

The number of bits in each sample/frame of data. Required.

io_pcm_data_format: Option<SampleFormat>

The data format over the transport for linear samples. Ignored for non-linear coding formats. Optional. SIGNED indicates 2’s complement sign encoding. FLOAT is not supported.

io_pcm_sample_payload_msb_position: Option<u8>

For linear samples, indicates how many bit positions the MSB of the sample is away from the MSB of the data. Ignored for non-linear coding formats. Optional. Default: 0.

path: Option<DataPath>

The data transport. Required.

max_tx_data_size: Option<u16>

Indicates the maximum data buffer size that may be sent. Optional. Only present after a connection has successfully been connected. Ignored when requesting a connection.

Trait Implementations

impl Clone for ScoConnectionParameters

fn clone(&self) -> ScoConnectionParameters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScoConnectionParameters

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

Formats the value using the given formatter.

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

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 ScoConnectionParameters

fn default() -> ScoConnectionParameters

Returns the “default value” for a type.

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

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 ScoConnectionParameters

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

type Owned = ScoConnectionParameters

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 ScoConnectionParameters

type Borrowed<'a> = &'a ScoConnectionParameters

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 ScoConnectionParameters

impl StructuralPartialEq for ScoConnectionParameters