Struct Gain

pub struct Gain {
    pub type_: Option<GainType>,
    pub domain: Option<GainDomain>,
    pub min_gain: Option<f32>,
    pub max_gain: Option<f32>,
    pub min_gain_step: Option<f32>,
    /* private fields */
}

Parameters for an Element with type equal to GAIN.

Fields

type_: Option<GainType>

Specifies what the numbers for gain represent, e.g. a percentage.

Required.

domain: Option<GainDomain>

If included, the gain is applied in the specified GainDomain. If not included, the gain domain is unspecified.

Optional.

min_gain: Option<f32>

Minimum gain in GainType format.

Required.

max_gain: Option<f32>

Maximum gain in GainType format.

Required.

min_gain_step: Option<f32>

Minimum gain step in GainType format, this value must not be negative, but may be zero to convey an effectively continuous range of values. Must not exceed max_gain - min_gain. The actual gain set may be queried by the client with a WatchElementState call.

Required.

Trait Implementations

impl Clone for Gain

fn clone(&self) -> Gain

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Gain

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

Formats the value using the given formatter.

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

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 Gain

fn default() -> Gain

Returns the “default value” for a type.

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

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 Gain

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

type Owned = Gain

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 Gain

type Borrowed<'a> = &'a Gain

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 Gain

impl StructuralPartialEq for Gain