Struct RateLimiter 

pub struct RateLimiter<A: Address, T, TargetRoute: DeliveryRoute<Protocol: Protocol<Addr = A, Msg = T>>, ReplyRoute: DeliveryRoute<Protocol: Protocol<Addr = A, Msg = RateLimiterOutcome<T>>>> { /* private fields */ }

Deterministic explicit-token admission behavior.

Admission atomically subtracts a positive cost and emits the value, or returns ownership with an exhaustive rejection. Typed refill observations saturate at capacity and cannot overflow. The initial count may be zero but cannot exceed positive capacity. Initialization is empty, no actors are created, and the host never terminates by policy. Token arithmetic, saturation, and rejection ordering are Bombay policy. Clock cadence is not observed here: a Periodic composition or Environment adapter supplies typed Refill events. No transition has a semantic panic condition.

Implementations

impl<A, T, TargetRoute, ReplyRoute> RateLimiter<A, T, TargetRoute, ReplyRoute>

where A: Address, TargetRoute: DeliveryRoute<Protocol: Protocol<Addr = A, Msg = T>>, ReplyRoute: DeliveryRoute<Protocol: Protocol<Addr = A, Msg = RateLimiterOutcome<T>>>,

pub fn new( capacity: TokenCount, initial: u64, ) -> Result<Self, RateLimiterConfigError>

Construct one explicit positive-capacity bucket.

Errors

Returns RateLimiterConfigError::InitialExceedsCapacity when invalid.

pub const fn state(&self) -> RateLimiterState

Return complete current capacity and token state.

Trait Implementations

impl<A, T, TargetRoute, ReplyRoute> Behavior for RateLimiter<A, T, TargetRoute, ReplyRoute>

where A: Address, TargetRoute: DeliveryRoute<Protocol: Protocol<Addr = A, Msg = T>>, ReplyRoute: DeliveryRoute<Protocol: Protocol<Addr = A, Msg = RateLimiterOutcome<T>>>, TargetRoute::Sends: SendsFor<User<A, RateLimiterMessage<T, TargetRoute, ReplyRoute>>>, ReplyRoute::Sends: SendsFor<User<A, RateLimiterMessage<T, TargetRoute, ReplyRoute>>>,

type Protocol = RateLimiter<A, T, TargetRoute, ReplyRoute>

Stable public communication identity owned by this actor template.

type Event = User<A, <<RateLimiter<A, T, TargetRoute, ReplyRoute> as Behavior>::Protocol as Protocol>::Msg>

type Sends = DeliveryOutcomes<<TargetRoute as DeliveryRoute>::Sends, <ReplyRoute as DeliveryRoute>::Sends>

type Ph = Never

type Error = Never

type Birth = NoBirths

fn transition( &mut self, _: ActiveTurn, event: Self::Event, ) -> BehaviorActed<Self>

Fold exactly one event into explicit actions and the next behavior.

fn init( &mut self, _turn: InitializationTurn, ) -> Result<Actions<<Self::Protocol as Protocol>::Addr, Self::Ph, Self::Sends, Self::Birth>, Self::Error>

where Self: Sized,

Produce initialization actions before the first event is accepted.

fn layer<L>(self, layer: L) -> <L as BehaviorLayer<Self>>::Output

where Self: Sized, L: BehaviorLayer<Self>,

Apply one statically dispatched construction layer.

impl<A, T, TargetRoute, ReplyRoute> BehaviorBase for RateLimiter<A, T, TargetRoute, ReplyRoute>

where A: Address, TargetRoute: DeliveryRoute<Protocol: Protocol<Addr = A, Msg = T>>, ReplyRoute: DeliveryRoute<Protocol: Protocol<Addr = A, Msg = RateLimiterOutcome<T>>>,

type Base = RateLimiter<A, T, TargetRoute, ReplyRoute>

fn base(&self) -> &Self

impl<A, T, TargetRoute, ReplyRoute> Protocol for RateLimiter<A, T, TargetRoute, ReplyRoute>

where A: Address, TargetRoute: DeliveryRoute<Protocol: Protocol<Addr = A, Msg = T>>, ReplyRoute: DeliveryRoute<Protocol: Protocol<Addr = A, Msg = RateLimiterOutcome<T>>>,

type Addr = A

type Msg = RateLimiterMessage<T, TargetRoute, ReplyRoute>