Skip to main content

Buffer

Struct Buffer 

Source
pub struct Buffer<A, T, TargetRoute, ReplyRoute>
where A: Address, TargetRoute: DeliveryRoute, TargetRoute::Protocol: Protocol<Addr = A, Msg = T>, ReplyRoute: DeliveryRoute, ReplyRoute::Protocol: Protocol<Addr = A, Msg = BufferOutcome<T>>,
{ /* private fields */ }
Expand description

Bounded FIFO policy behavior over typed actor deliveries.

State is the named BufferState product. Offers below capacity commit ownership and report Accepted. At capacity, OverflowPolicy either returns the new value, or returns the oldest value before accepting the new one. Release moves exactly the oldest value to the destination lane and reports the remaining depth; empty release reports Empty. No payload is silently discarded. Initialization is empty, transitions do not create actors, and the buffer never terminates itself. FIFO and overflow semantics are Bombay policy. Physical mailbox buffering, admission, fairness, and backpressure remain bombay-communication responsibilities. Construction returns BufferConfigError rather than creating an ownership sink. The internal full-queue eviction uses the proven invariant that positive capacity plus the full-offer branch implies a non-empty queue; callers cannot violate that invariant through the public API.

Implementations§

Source§

impl<A, T, TargetRoute, ReplyRoute> Buffer<A, T, TargetRoute, ReplyRoute>
where A: Address, TargetRoute: DeliveryRoute, TargetRoute::Protocol: Protocol<Addr = A, Msg = T>, ReplyRoute: DeliveryRoute, ReplyRoute::Protocol: Protocol<Addr = A, Msg = BufferOutcome<T>>,

Source

pub fn new(configuration: BufferConfiguration) -> Self

Bind validated policy to an empty buffer actor.

Source

pub const fn state(&self) -> &BufferState<T, ReplyRoute>

Borrow the complete current buffer state.

Trait Implementations§

Source§

impl<A, T, TargetRoute, ReplyRoute> Behavior for Buffer<A, T, TargetRoute, ReplyRoute>
where A: Address, TargetRoute: DeliveryRoute, TargetRoute::Protocol: Protocol<Addr = A, Msg = T>, ReplyRoute: DeliveryRoute + Clone, ReplyRoute::Protocol: Protocol<Addr = A, Msg = BufferOutcome<T>>, TargetRoute::Sends: SendsFor<User<A, BufferMessage<T, TargetRoute, ReplyRoute>>>, ReplyRoute::Sends: SendsFor<User<A, BufferMessage<T, TargetRoute, ReplyRoute>>>,

Source§

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

Stable public communication identity owned by this actor template. Read more
Source§

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

Source§

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

Source§

type Ph = Never

Source§

type Error = Never

Source§

type Birth = NoBirths

Source§

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

Fold exactly one event into explicit actions and the next behavior. Read more
Source§

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. Read more
Source§

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

Apply one statically dispatched construction layer. Read more
Source§

impl<A, T, TargetRoute, ReplyRoute> BehaviorBase for Buffer<A, T, TargetRoute, ReplyRoute>
where A: Address, TargetRoute: DeliveryRoute, TargetRoute::Protocol: Protocol<Addr = A, Msg = T>, ReplyRoute: DeliveryRoute, ReplyRoute::Protocol: Protocol<Addr = A, Msg = BufferOutcome<T>>,

Source§

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

Source§

fn base(&self) -> &Self

Source§

impl<A, T, TargetRoute, ReplyRoute> Protocol for Buffer<A, T, TargetRoute, ReplyRoute>
where A: Address, TargetRoute: DeliveryRoute, TargetRoute::Protocol: Protocol<Addr = A, Msg = T>, ReplyRoute: DeliveryRoute, ReplyRoute::Protocol: Protocol<Addr = A, Msg = BufferOutcome<T>>,

Source§

type Addr = A

Source§

type Msg = BufferMessage<T, TargetRoute, ReplyRoute>

Auto Trait Implementations§

§

impl<A, T, TargetRoute, ReplyRoute> Freeze for Buffer<A, T, TargetRoute, ReplyRoute>

§

impl<A, T, TargetRoute, ReplyRoute> RefUnwindSafe for Buffer<A, T, TargetRoute, ReplyRoute>
where T: RefUnwindSafe, ReplyRoute: RefUnwindSafe,

§

impl<A, T, TargetRoute, ReplyRoute> Send for Buffer<A, T, TargetRoute, ReplyRoute>
where T: Send, ReplyRoute: Send,

§

impl<A, T, TargetRoute, ReplyRoute> Sync for Buffer<A, T, TargetRoute, ReplyRoute>
where T: Sync, ReplyRoute: Sync,

§

impl<A, T, TargetRoute, ReplyRoute> Unpin for Buffer<A, T, TargetRoute, ReplyRoute>
where T: Unpin, ReplyRoute: Unpin,

§

impl<A, T, TargetRoute, ReplyRoute> UnsafeUnpin for Buffer<A, T, TargetRoute, ReplyRoute>

§

impl<A, T, TargetRoute, ReplyRoute> UnwindSafe for Buffer<A, T, TargetRoute, ReplyRoute>
where T: UnwindSafe, ReplyRoute: UnwindSafe,

Blanket Implementations§

Source§

impl<B> Activate for B
where B: Behavior,

Source§

fn initialize(self) -> Result<Initialized<Self>, Self::Error>

Consume this definition, perform its one initialization fold, and return the active behavior together with the ordered initialization effects. Read more
Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<B> BeginShutdownPhases for B
where B: Behavior, <<B as Behavior>::Birth as BirthMode>::Child: ChildOccurrenceProduct<AvailableChildren>,

Source§

impl<Node> BirthNodeAppend<Never> for Node
where Node: NonEmptyBirthNode,

Source§

type Output = Node

Closed child algebra containing the complete prefix followed by the complete appended tail.
Source§

fn append_prefix(self) -> <Node as BirthNodeAppend<Never>>::Output

Inject one child from the existing prefix without changing its structural occurrence.
Source§

fn append_tail(tail: Never) -> <Node as BirthNodeAppend<Never>>::Output

Inject one child from the appended tail after every prefix occurrence.
Source§

fn append_creations<A>( prefix: Creations<CreateChild<A, Self>>, tail: Creations<CreateChild<A, Tail>>, ) -> Creations<CreateChild<A, Self::Output>>
where A: Address,

Preserve and concatenate two ordered creation batches.
Source§

impl<Child, Tail> BirthNodeAppend<Tail> for Child
where Child: Behavior, Tail: NonEmptyBirthNode,

Source§

type Output = ChildChoice<Child, Tail>

Closed child algebra containing the complete prefix followed by the complete appended tail.
Source§

fn append_prefix(self) -> <Child as BirthNodeAppend<Tail>>::Output

Inject one child from the existing prefix without changing its structural occurrence.
Source§

fn append_tail(tail: Tail) -> <Child as BirthNodeAppend<Tail>>::Output

Inject one child from the appended tail after every prefix occurrence.
Source§

fn append_creations<A>( prefix: Creations<CreateChild<A, Self>>, tail: Creations<CreateChild<A, Tail>>, ) -> Creations<CreateChild<A, Self::Output>>
where A: Address,

Preserve and concatenate two ordered creation batches.
Source§

impl<B> BirthProtocols for B
where B: Behavior, <B as Behavior>::Birth: BirthModeProtocols,

Source§

type Protocols = BirthProtocol<<B as Behavior>::Protocol, <<B as Behavior>::Birth as BirthModeProtocols>::Protocols>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<Node, Shape> ChildOccurrenceProduct<Shape> for Node
where Node: ChildOccurrenceProductAt<ChildHead, Shape>, Shape: ChildOccurrenceShape,

Source§

type Product = <Node as ChildOccurrenceProductAt<ChildHead, Shape>>::Product

Complete shape-owned representation of this closed birth node.
Source§

impl<A, Child, Host> DispatchBirth<A, Host> for Child
where A: Address, Child: CreateSelectedChild<A, ChildHead, Host>,

Source§

fn dispatch_birth( self, id: CreationId, route: <A as Address>::Nonce, kind: CreationKind, host: &mut Host, ) -> impl Future<Output = ItemSettlement<RoutedCreation<A, Child>, <Child as ChildCreationProduct<A, ChildHead>>::Result, CreationRejection, Never>> + Send

Select exactly one concrete child host while preserving creation data in every non-accepted settlement.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.