Struct GainProperties

pub struct GainProperties {
    pub gain_state: Option<GainState>,
    pub min_gain_db: Option<f32>,
    pub max_gain_db: Option<f32>,
    pub gain_step_db: Option<f32>,
    pub can_mute: Option<bool>,
    pub can_agc: Option<bool>,
    /* private fields */
}

Fields

gain_state: Option<GainState>

The initial gain state at device initialization time.

Required.

min_gain_db: Option<f32>

The device’s minimum gain, in decibels.

Optional.

max_gain_db: Option<f32>

The device’s maximum gain, in decibels.

Optional.

gain_step_db: Option<f32>

The precision of each gain-change step, in decibels.

Optional.

can_mute: Option<bool>

If true, the device contains a distinct MUTE control. If false or absent, it does not.

Optional.

can_agc: Option<bool>

Automatic Gain Control. If absent, this hardware does not support AGC.

Optional.

Trait Implementations

impl Clone for GainProperties

fn clone(&self) -> GainProperties

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GainProperties

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

Formats the value using the given formatter.

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

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 GainProperties

fn default() -> GainProperties

Returns the “default value” for a type.

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

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 GainProperties

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

type Owned = GainProperties

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 GainProperties

type Borrowed<'a> = &'a GainProperties

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 GainProperties

impl StructuralPartialEq for GainProperties