Struct thespis_impl::ActorBuilder

pub struct ActorBuilder<A: Actor> { /* private fields */ }

Builder for Addr and Mailbox. This is a convenience API so you don’t have to call their constructors manually. Mainly lets you set the channel and name for your mailbox.

Also provides methods for spawning the mailbox immediately as well as a build method which lets you do it manually.

Implementations

impl<A: Actor> ActorBuilder<A>

pub fn new() -> Self

Create a new ActorBuilder with default settings.

pub fn name(self, name: impl AsRef<str>) -> Self

Configure a name for this actor. This will be helpful for interpreting debug logs. You can also retrieve the name later on both the Addr and the Mailbox.

pub fn bounded(self, bounded: Option<usize>) -> Self

Choose the bounded size of the default channel. If unset, will default to a bounded channel with a buffer size of 16. Note that thespis messages are boxed, so the buffer is only the size of 16 fat pointers. It still means consuming the actual heap storage if you count on the channel backpressure to keep your memory consumption down.

If you set this to None, you will get an unbounded channel.

This option is incompatible with manually providing a channel. Only works for the default channel.

Panics

In debug mode this will panic if you have already called ActorBuilder::channel.

pub fn channel(self, tx: ChanSender<A>, rx: ChanReceiver<A>) -> Self

Set the channel to use for communication between Addr and Mailbox.

This option is incompatible with bounded.

Panics

In debug mode this will panic if you have already called ActorBuilder::bounded.

pub fn build(self) -> (Addr<A>, Mailbox<A>)

Build Addr and Mailbox. This does not yet consume an actor and you have to call start or start_local on Mailbox and spawn the future to run your actor.

The advantage of this method is that you can pass the Addr to the constructor of your actor if you need to. Otherwise it’s advised to use ActorBuilder::spawn_handle or ActorBuilder::spawn_handle_local for convenience.

pub fn spawn(self, actor: A, exec: &dyn Spawn) -> Result<Addr<A>, ThesErr> where
    A: Send, 

Spawn the mailbox on the provided executor. Returns Addr. Note that this detaches the mailbox on spawning. That means the actor will keep running until all Addr to it have been dropped.

If you want more control over stopping the actor, look at ActorBuilder::spawn_handle or ActorBuilder::build.

pub fn spawn_handle(
    self,
    actor: A,
    exec: &dyn SpawnHandle<MailboxEnd<A>>
) -> Result<(Addr<A>, JoinHandle<MailboxEnd<A>>), ThesErr> where
    A: Send, 

Spawn the mailbox on the provided executor. Returns Addr and a JoinHandle to the spawned mailbox.

Note that if you drop the JoinHandle it will stop the actor and drop it unless you call JoinHandle::detach on it.

The JoinHandle returns:

• MailboxEnd::Mailbox if you actor panicked whilst processing a message. This way you can instantiate a new actor and spawn the mailbox again. This can be used for supervision. All existing addresses will remain valid when this happens.
• MailboxEnd::Actor when the mailbox ends naturally. You can create a new mailbox and spawn the actor again if you want to re-use it.

pub fn spawn_local(
    self,
    actor: A,
    exec: &dyn LocalSpawn
) -> Result<Addr<A>, ThesErr>

For Actor: !Send. Spawn the mailbox on the provided executor. Returns the Addr.

If you want more control over stopping the actor, look at ActorBuilder::spawn_handle_local or ActorBuilder::build.

pub fn spawn_handle_local(
    self,
    actor: A,
    exec: &dyn LocalSpawnHandle<MailboxEnd<A>>
) -> Result<(Addr<A>, JoinHandle<MailboxEnd<A>>), ThesErr>

For Actor: !Send. Spawn the mailbox on the provided executor. Returns Addr and a JoinHandle to the spawned mailbox.

Note that if you drop the JoinHandle it will stop the actor and drop it unless you call JoinHandle::detach on it.

Trait Implementations

impl<A: Actor> Debug for ActorBuilder<A>

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

Formats the value using the given formatter.

impl<A: Actor> Default for ActorBuilder<A>

fn default() -> Self

Returns the “default value” for a type.