Struct Multiport

pub struct Multiport<T: Sync> { /* private fields */ }

A multiport is a vector of independent ports (its channels) Multiports have special Lingua Franca syntax, similar to reactor banks.

Implementations

impl<T: Sync> Multiport<T>

pub fn len(&self) -> usize

Returns the number of channels.

pub fn is_empty(&self) -> bool

Returns true if this multiport is empty.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut Port<T>>

Iterate over the multiport and return mutable references to individual channels.

pub fn iter(&self) -> impl Iterator<Item = &Port<T>>

Iterate over the channels of this multiport. Returns read-only references to individual ports.

pub fn enumerate_set(&self) -> impl Iterator<Item = (usize, &Port<T>)>

Iterate over only those channels that are set (have a value). Returns a tuple with their index (not necessarily contiguous).

pub fn iterate_set(&self) -> impl Iterator<Item = &Port<T>>

Iterate over only those channels that are set (have a value). The returned ports are not necessarily contiguous. See Self::enumerate_set to get access to their index.

pub fn iterate_values(&self) -> impl Iterator<Item = T> + '_

where T: Copy,

Iterate over only those channels that are set (have a value), and return a copy of the value. The returned ports are not necessarily contiguous. See Self::enumerate_values to get access to their index.

pub fn iterate_values_ref(&self) -> impl Iterator<Item = &T> + '_

Iterate over only those ports that are set (have a value), and return a reference to the value. The returned ports are not necessarily contiguous. See Self::enumerate_values to get access to their index.

pub fn enumerate_values(&self) -> impl Iterator<Item = (usize, T)> + '_

where T: Copy,

Iterate over only those channels that are set (have a value), yielding a tuple with their index in the bank and a copy of the value.

pub fn enumerate_values_ref(&self) -> impl Iterator<Item = (usize, &T)> + '_

Iterate over only those channels that are set (have a value), yielding a tuple with their index in the bank and a reference to the value.

Trait Implementations

impl<T: Sync> Index<usize> for Multiport<T>

type Output = Port<T>

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T: Sync> IndexMut<usize> for Multiport<T>

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<'a, T: Sync> IntoIterator for &'a Multiport<T>

type Item = &'a Port<T>

The type of the elements being iterated over.

type IntoIter = Iter<'a, Port<T>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T: Sync> IntoIterator for &'a mut Multiport<T>

type Item = &'a mut Port<T>

The type of the elements being iterated over.

type IntoIter = IterMut<'a, Port<T>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.