Struct maxim::actors::ActorBuilder

pub struct ActorBuilder {
    pub name: Option<String>,
    pub channel_size: Option<u16>,
    // some fields omitted
}

A builder that can be used to create and spawn an actor. To get a builder, the user would ask the actor system to create one using system.spawn() and then to spawn the actor by means of the the with method on the builder. See ActorSystem::spawn for more information.

Fields

name: Option<String>

The optional name of the actor which defaults to None meaning the actor will be unnamed.

channel_size: Option<u16>

The size of the message channel for the actor which defaults to None; meaning the default for the actor system will be used for the message channel.

Methods

impl ActorBuilder

pub fn with<F, S, R>(self, state: S, processor: F) -> Result<Aid, SystemError> where
    S: Send + Sync + 'static,
    R: Future<Output = ActorResult<S>> + Send + 'static,
    F: Processor<S, R> + 'static, 

Completes the spawning of the the actor configured with this builder on the system, consuming the builder in the process and using the provided state and handler. See ActorSystem::spawn for more information and examples.

pub fn name(self, name: impl Into<String>) -> Self

Set the name of the actor to the given string.

pub fn channel_size(self, size: u16) -> Self

Set the size of the channel to the given value instead of the default for the actor system that the actor is spawned on. Note that passing a value less than 1 will cause a panic and there would be little reason to do so anyway.

Trait Implementations

impl Clone for ActorBuilder

fn clone(&self) -> ActorBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.