Struct Topology

pub struct Topology {
    pub id: Option<u64>,
    pub processing_elements_edge_pairs: Option<Vec<EdgePair>>,
    /* private fields */
}

A Topology specifies one way processing elements are arranged within the hardware.

Fields

id: Option<u64>

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

Required.

processing_elements_edge_pairs: Option<Vec<EdgePair>>

Vector of processing elements edge pairs in this order. The ordering of processing elements with edge pairs form pipelines. To define multiple possible pipelines, return more Topology entries in GetTopologies.

Required.

Trait Implementations

impl Clone for Topology

fn clone(&self) -> Topology

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Topology

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

Formats the value using the given formatter.

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

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 Topology

fn default() -> Topology

Returns the “default value” for a type.

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

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 Topology

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

type Owned = Topology

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 Topology

type Borrowed<'a> = &'a Topology

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 Topology

impl StructuralPartialEq for Topology