Struct Queue 

pub struct Queue<T>
where
    T: SimObject,
{ /* private fields */ }

A generic queue component with rx and tx ports.

Implementations

impl<T> Queue<T>

where T: SimObject,

pub fn new_and_register_with_renames( engine: &Engine, clock: &Clock, parent: &Rc<Entity>, name: &str, aka: Option<&Aka>, capacity: Option<usize>, ) -> Result<Rc<Self>, SimError>

Create and register a new queue component.

Returns a [SimError] if capacity is Some(0).

pub fn new_and_register( engine: &Engine, clock: &Clock, parent: &Rc<Entity>, name: &str, capacity: Option<usize>, ) -> Result<Rc<Self>, SimError>

Create and register a new queue component.

Returns a [SimError] if capacity is Some(0).

pub fn connect_port_tx(&self, port_state: PortStateResult<T>) -> SimResult

pub fn port_rx(&self) -> PortStateResult<T>

pub fn len(&self) -> usize

Return the current queue length.

pub fn is_empty(&self) -> bool

Return whether the queue is empty.

pub fn is_full(&self) -> bool

Return whether the queue is full.

pub fn values(&self) -> Vec<T>

Return a snapshot of the queue contents by copying all values.

pub fn changed_event(&self) -> Repeated<()>

Return an event that fires whenever the queue contents change.

Trait Implementations

impl<T> Debug for Queue<T>

where T: SimObject,

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

Formats the value using the given formatter.

impl<T> Display for Queue<T>

where T: SimObject,

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

Formats the value using the given formatter.

impl<T> GetEntity for Queue<T>

where T: SimObject,

fn entity(&self) -> &Rc<Entity>

Return the [Entity]

impl<T> Runnable for Queue<T>

where T: SimObject,

fn run<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = SimResult> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Provides the method that defines the active element of this component.