Struct ActorBuilder

pub struct ActorBuilder<T, A: ActorState> { /* private fields */ }

Holds a type that implements ActorState, helps aggregate all data that the actor needs, and then launches the async actor process. When the actor process is launched, a client is returned to the caller. This client’s type depends on the actor’s type.

Implementations

impl<T, A> ActorBuilder<T, A>

where A: ActorState<ActorType = T>,

pub fn new(state: A) -> Self

Constructs a new builder for an actor that uses the given state.

pub fn attach_stream<S, I>(&mut self, stream: S)

where S: SendableFusedStream<Item = I>, I: Into<A::Message>,

Attaches a stream that will be used by the actor once its spawned. No messages will be processed until after the actor is launched.

impl<A> ActorBuilder<SinkActor, A>

where A: ActorState<ActorType = SinkActor>,

pub fn client(&self) -> SinkClient<A::Permanence, A::Message>

Returns a client for the actor that will be spawned. While the returned client will be able to send messages, those messages will not be processed until after the actor is launched by the builder.

pub fn launch(self) -> SinkClient<A::Permanence, A::Message>

Launches an actor that uses the given state and returns a client to the actor.

impl<A> ActorBuilder<StreamActor, A>

where A: ActorState<ActorType = StreamActor>,

pub fn client(&mut self) -> StreamClient<A::Output>

Returns a client for the actor that will be spawned. The client will not yield any messages until after the actor is launched and has sent a message.

pub fn launch<S>(self, stream: S) -> StreamClient<A::Output>

where S: SendableFusedStream<Item = A::Message>,

Launches an actor that uses the given state. Returns a client to the actor.

impl<A> ActorBuilder<JointActor, A>

where A: ActorState<ActorType = JointActor>,

pub fn stream_client(&self) -> StreamClient<A::Output>

Returns a stream client for the actor that will be spawned. The client will not yield any messages until after the actor is launched and has sent a message.

pub fn sink_client(&self) -> SinkClient<A::Permanence, A::Message>

Returns a sink client for the actor that will be spawned. While the returned client will be able to send messages, those messages will not be processed until after the actor is launched by the builder.

pub fn client(&self) -> SinkClient<A::Permanence, A::Message>

Returns a joint client for the actor that will be spawned. While the returned client will be able to send messages, those messages will not be processed until after the actor is launched by the builder. The client will also not yield any messages until after the actor is launched and has sent a message.

pub fn launch_with_stream<S>( self, stream: S, ) -> JointClient<A::Permanence, A::Message, A::Output>

where S: SendableFusedStream<Item = A::Message>,

Launches an actor that uses the given state and stream. Returns a client to the actor.

pub fn launch(self) -> JointClient<A::Permanence, A::Message, A::Output>

Launches an actor that uses the given state. Returns a client to the actor.