Skip to main content

Router

Struct Router 

Source
pub struct Router<A: Address, Route: DeliveryRoute<Protocol: Protocol<Addr = A>> + Clone + PartialEq, R> { /* private fields */ }
Expand description

A pure typed router over one concrete destination protocol.

State is the insertion-ordered recipient product plus a statically selected policy. Inputs are RouterMessage; outputs are the concrete send product selected by Route. Initialization is empty. Successful membership transitions emit no effects. A successful route transfers ownership to one selected member and continues; an empty selection returns RouterError without changing membership. Fan-out is the distinct crate::Topic or crate::PubSub law and therefore does not impose a message-cloning bound on this unicast actor. The router never terminates by policy and requires only Bombay Address and Communication interpretation for its send lane.

Implementations§

Source§

impl<A, Route, R> Router<A, Route, R>
where A: Address, Route: DeliveryRoute<Protocol: Protocol<Addr = A>> + Clone + PartialEq, R: RoutingStrategy<Route>,

Source

pub fn new(recipients: Vec<Route>, strategy: R) -> Self

Construct a definition from explicit initial membership and policy.

Source

pub fn recipients(&self) -> &[Route]

Current eligible recipients in observable routing order.

Source

pub const fn strategy(&self) -> &R

Borrow the concrete static policy state.

Source§

impl<A, Route> Router<A, Route, LeastLoaded>
where A: Address, Route: DeliveryRoute<Protocol: Protocol<Addr = A>> + Clone + PartialEq,

Source

pub fn load_evidence(&self, recipient: &Route) -> Option<LoadEvidence>

Borrow the current load-evidence phase of one member.

Returns None when the route is not a current member. Removal retires its old evidence, so a later addition starts at LoadEvidence::Unknown.

Source§

impl<A, Route, K> Router<A, Route, ConsistentHash<K>>
where A: Address, Route: DeliveryRoute<Protocol: Protocol<Addr = A>> + Clone + PartialEq, <Route::Protocol as Protocol>::Msg: RouteKey<K>,

Source

pub fn member_token_evidence( &self, recipient: &Route, ) -> Option<MemberTokenEvidence>

Borrow one current member’s complete stable-token evidence. Removal retires the old evidence; later addition starts Unknown.

Source§

impl<A, Route, K> Router<A, Route, RendezvousHash<K>>
where A: Address, Route: DeliveryRoute<Protocol: Protocol<Addr = A>> + Clone + PartialEq, <Route::Protocol as Protocol>::Msg: RouteKey<K>,

Source

pub fn member_token_evidence( &self, recipient: &Route, ) -> Option<MemberTokenEvidence>

Borrow one current member’s complete stable-token evidence. Removal retires the old evidence; later addition starts Unknown.

Trait Implementations§

Source§

impl<A, Route, R> Behavior for Router<A, Route, R>
where A: Address, Route: DeliveryRoute<Protocol: Protocol<Addr = A>> + Clone + PartialEq, R: RoutingStrategy<Route>, Route::Sends: SendsFor<User<A, RouterMessage<Route, R>>>,

Source§

type Protocol = Router<A, Route, R>

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

type Event = User<A, RouterMessage<Route, R>>

Source§

type Sends = <Route as DeliveryRoute>::Sends

Source§

type Ph = Never

Source§

type Error = RouterError<<<Route as DeliveryRoute>::Protocol as Protocol>::Msg, <R as RoutingStrategy<Route>>::Observation, <R as RoutingStrategy<Route>>::Error>

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, Route, R> BehaviorBase for Router<A, Route, R>
where A: Address, Route: DeliveryRoute<Protocol: Protocol<Addr = A>> + Clone + PartialEq, R: RoutingStrategy<Route>,

Source§

type Base = Router<A, Route, R>

Source§

fn base(&self) -> &Self::Base

Source§

impl<A, Route, R> Protocol for Router<A, Route, R>
where A: Address, Route: DeliveryRoute<Protocol: Protocol<Addr = A>> + Clone + PartialEq, R: RoutingStrategy<Route>,

Source§

type Addr = A

Source§

type Msg = RouterMessage<Route, R>

Auto Trait Implementations§

§

impl<A, Route, R> Freeze for Router<A, Route, R>
where R: Freeze,

§

impl<A, Route, R> RefUnwindSafe for Router<A, Route, R>
where R: RefUnwindSafe, Route: RefUnwindSafe,

§

impl<A, Route, R> Send for Router<A, Route, R>
where R: Send, Route: Send,

§

impl<A, Route, R> Sync for Router<A, Route, R>
where R: Sync, Route: Sync,

§

impl<A, Route, R> Unpin for Router<A, Route, R>
where R: Unpin, Route: Unpin,

§

impl<A, Route, R> UnsafeUnpin for Router<A, Route, R>
where R: UnsafeUnpin,

§

impl<A, Route, R> UnwindSafe for Router<A, Route, R>
where R: UnwindSafe, Route: 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.