Struct Limiter

pub struct Limiter<T>
where
    T: SimObject,
{
    pub entity: Rc<Entity>,
    /* private fields */
}

The Limiter is a component that will allow data through at a specified rate.

The rate is defined in bits-per-second.

Fields

entity: Rc<Entity>

Implementations

impl<T> Limiter<T>

where T: SimObject,

pub fn new_and_register( engine: &Engine, parent: &Rc<Entity>, name: &str, limiter: Rc<RateLimiter<T>>, ) -> Result<Rc<Self>, SimError>

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

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

Trait Implementations

impl<T> Display for Limiter<T>

where T: SimObject,

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

Formats the value using the given formatter.

impl<T> Runnable for Limiter<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.