Struct xdevs::port::Port

pub struct Port<T: Clone, const N: usize>(/* private fields */);

Port is a generic structure that can be used to store values of any type T. It is the main artifact to exchange data between components. Note that, in no_std environments, the capacity of the port N must be known at compile time.

Implementations

impl<T: Clone, const N: usize> Port<T, N>

pub const fn new() -> Self

Creates a new empty port.

pub fn is_empty(&self) -> bool

Returns true if the port is empty.

pub fn is_full(&self) -> bool

Returns true if the port is full.

pub fn len(&self) -> usize

Returns the number of elements in the port.

pub fn clear(&mut self)

Clears the port, removing all values.

pub fn add_value(&mut self, item: T) -> Result<(), T>

Adds a value to the port.

pub fn add_values(&mut self, items: &[T]) -> Result<(), ()>

Adds multiple values to the port.

pub fn get_values(&self) -> &[T]

Returns a slice of the port’s values.

Trait Implementations

impl<T: Clone, const N: usize> Bag for Port<T, N>

fn is_empty(&self) -> bool

Returns true if the ports are empty.

fn clear(&mut self)

Clears the ports, removing all values.

impl<T: Debug + Clone, const N: usize> Debug for Port<T, N>

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

Formats the value using the given formatter.

impl<T: Default + Clone, const N: usize> Default for Port<T, N>

fn default() -> Port<T, N>

Returns the “default value” for a type.