Struct riker::actor::Props

pub struct Props;

Provides instances of ActorProducer for use when creating Actors (actor_of_props).

Actors are not created directly. Instead you provide an ActorProducer that allows the ActorSystem to start an actor when actor_of_props is used, or when an actor fails and a supervisor requests an actor to be restarted.

ActorProducer can hold values required by the actor's factory method parameters.

Implementations

impl Props

pub fn new_from<A, F>(creator: F) -> Arc<Mutex<impl ActorProducer<Actor = A>>> where
    A: Actor + Send + 'static,
    F: Fn() -> A + Send + 'static, 

Creates an ActorProducer with no factory method parameters.

Examples

struct User;

impl User {
    fn actor() -> Self {
        User
    }
}

// main
let sys = ActorSystem::new().unwrap();

let props = Props::new_from(User::actor);

// start the actor and get an `ActorRef`
let actor = sys.actor_of_props("user", props).unwrap();

pub fn new_from_args<A, Args, F>(
    creator: F,
    args: Args
) -> Arc<Mutex<impl ActorProducer<Actor = A>>> where
    A: Actor + Send + 'static,
    Args: ActorArgs,
    F: Fn(Args) -> A + Send + 'static, 

Creates an ActorProducer with one or more factory method parameters.

Examples

An actor requiring a single parameter.

struct User {
    name: String,
}

impl User {
    fn actor(name: String) -> Self {
        User {
            name
        }
    }
}

// main
let sys = ActorSystem::new().unwrap();

let props = Props::new_from_args(User::actor, "Naomi Nagata".into());

let actor = sys.actor_of_props("user", props).unwrap();

An actor requiring multiple parameters.

struct BankAccount {
    name: String,
    number: String,
}

impl BankAccount {
    fn actor((name, number): (String, String)) -> Self {
        BankAccount {
            name,
            number
        }
    }
}

// main
let sys = ActorSystem::new().unwrap();

let props = Props::new_from_args(BankAccount::actor,
                            ("James Holden".into(), "12345678".into()));

// start the actor and get an `ActorRef`
let actor = sys.actor_of_props("bank_account", props).unwrap();

pub fn new<A>() -> Arc<Mutex<impl ActorProducer<Actor = A>>> where
    A: ActorFactory, 

Creates an ActorProducer from default constructible type with no factory method parameters.

Examples

#[derive(Default)]
struct User;

// main
let sys = ActorSystem::new().unwrap();

let props = Props::new::<User>();

// start the actor and get an `ActorRef`
let actor = sys.actor_of_props("user", props).unwrap();

Creates an ActorProducer from a type which implements ActorFactory with no factory method parameters.

Examples

struct User;

impl ActorFactory for User {
    fn create() -> Self {
        User
    }
}

// main
let sys = ActorSystem::new().unwrap();

let props = Props::new::<User>();

// start the actor and get an `ActorRef`
let actor = sys.actor_of_props("user", props).unwrap();

pub fn new_args<A, Args>(
    args: Args
) -> Arc<Mutex<impl ActorProducer<Actor = A>>> where
    A: ActorFactoryArgs<Args>,
    Args: ActorArgs, 

Creates an ActorProducer from a type which implements ActorFactoryArgs with one or more factory method parameters.

Examples

An actor requiring a single parameter.

struct User {
    name: String,
}

impl ActorFactoryArgs<String> for User {
    fn create_args(name: String) -> Self {
        User {
            name
        }
    }
}

// main
let sys = ActorSystem::new().unwrap();

let props = Props::new_args::<User, _>("Naomi Nagata".into());

let actor = sys.actor_of_props("user", props).unwrap();

An actor requiring multiple parameters.

struct BankAccount {
    name: String,
    number: String,
}

impl ActorFactoryArgs<(String, String)> for BankAccount {
    fn create_args((name, number): (String, String)) -> Self {
        BankAccount {
            name,
            number
        }
    }
}

// main
let sys = ActorSystem::new().unwrap();

let props = Props::new_from_args(BankAccount::create_args,
                            ("James Holden".into(), "12345678".into()));

// start the actor and get an `ActorRef`
let actor = sys.actor_of_props("bank_account", props).unwrap();