Struct SettableElementState

pub struct SettableElementState {
    pub type_specific: Option<SettableTypeSpecificElementState>,
    pub vendor_specific_data: Option<Vec<u8>>,
    pub started: Option<bool>,
    pub bypassed: Option<bool>,
    /* private fields */
}
Expand description

Processing element state that can be set by clients.

Fields§

§type_specific: Option<SettableTypeSpecificElementState>

Type-specific state parameters for the processing element.

If this processing element is disabled and its type-specific state is provided, then the type-specific state is only informational, for instance if a SetElementState enables a disabled processing element providing a SettableTypeSpecificElementState, then any previous informational SettableTypeSpecificElementState is superceded.

If not set, then the element’s previous type_specific state will be unchanged.

Optional for Dynamics, Equalizer, Gain and VendorSpecific types. Invalid if included for any other element type.

§vendor_specific_data: Option<Vec<u8>>

If included, an opaque object of octets for exchanging vendor specific information. This can send vendor-specific data to any element, not just the VendorSpecific type.

Optional.

§started: Option<bool>

Whether to start this processing element (or to stop it, if false). A stopped processing element does not provide its abstracted functionality. Specifically, no audio data flows through a stopped element.

If the corresponding Element returned can_stop equals to false, then this field must not be set to false. If not set, then the element’s previous started state will be unchanged.

Optional.

§bypassed: Option<bool>

Whether to bypass this processing element (or to enable/“unbypass” it, if false). A bypassed element does not affect the flow of audio through the topology. Specifically, audio flows through the element without any change.

If the corresponding Element contains a can_bypass of false, then this field must not be set to true. If not set, then the element’s previous bypassed state will be unchanged.

Optional.

Trait Implementations§

§

impl Clone for SettableElementState

§

fn clone(&self) -> SettableElementState

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

impl Debug for SettableElementState

§

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

Formats the value using the given formatter. Read more
§

impl<D> Decode<SettableElementState, D> for SettableElementState
where D: ResourceDialect,

§

fn new_empty() -> SettableElementState

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<(), Error>

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

impl Default for SettableElementState

§

fn default() -> SettableElementState

Returns the “default value” for a type. Read more
§

impl<D> Encode<SettableElementState, D> for &SettableElementState
where D: ResourceDialect,

§

unsafe fn encode( self, encoder: &mut Encoder<'_, D>, offset: usize, depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
§

impl PartialEq for SettableElementState

§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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 SettableElementState

§

type Owned = SettableElementState

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. Read more
§

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 SettableElementState

§

type Borrowed<'a> = &'a SettableElementState

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &Self::Owned. There are three cases: Read more
§

fn borrow( value: &<SettableElementState as TypeMarker>::Owned, ) -> <SettableElementState as ValueTypeMarker>::Borrowed<'_>

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

impl Persistable for SettableElementState

§

impl StructuralPartialEq for SettableElementState

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Body for T
where T: Persistable,

§

type MarkerAtTopLevel = T

The marker type to use when the body is at the top-level.
§

type MarkerInResultUnion = T

The marker type to use when the body is nested in a result union.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T, D> Encode<Ambiguous1, D> for T
where D: ResourceDialect,

§

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
§

impl<T, D> Encode<Ambiguous2, D> for T
where D: ResourceDialect,

§

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
§

impl<E> ErrorType for E
where E: ValueTypeMarker<Owned = E> + Decode<E, DefaultFuchsiaResourceDialect>,

§

type Marker = E

The marker type.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.