Struct Element

pub struct Element {
    pub id: Option<u64>,
    pub type_: Option<ElementType>,
    pub type_specific: Option<TypeSpecificElement>,
    pub can_disable: Option<bool>,
    pub description: Option<String>,
    pub can_stop: Option<bool>,
    pub can_bypass: Option<bool>,
    /* private fields */
}

Fields

id: Option<u64>

Unique ID for this element. The scope of this id is only within the SignalProcessing protocol lifespan, i.e. until the channel associated with the protocol is closed.

Required.

type_: Option<ElementType>

Processing element type.

Required.

type_specific: Option<TypeSpecificElement>

If included, type-specific parameters for the processing element.

Optional.

can_disable: Option<bool>

If included and true, the processing element can be disabled via ElementSetState. If not included or false, the processing element is always enabled.

Optional.

Deprecation

Use can_bypass instead.

description: Option<String>

If included, a textual description of the processing element.

Optional.

can_stop: Option<bool>

If included and true, the processing element can be stopped via ElementSetState. If not included or false, the processing element is always started.

Optional.

can_bypass: Option<bool>

If included and true, the processing element can be bypassed via ElementSetState. If not included or false, the processing element cannot be bypassed.

Optional.

Trait Implementations

impl Clone for Element

fn clone(&self) -> Element

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Element

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

Formats the value using the given formatter.

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

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 Element

fn default() -> Element

Returns the “default value” for a type.

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

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 Element

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

type Owned = Element

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 Element

type Borrowed<'a> = &'a Element

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 Element

impl StructuralPartialEq for Element