Struct actix::System

pub struct System { /* private fields */ }

System is an actor which manages runtime.

Before starting any actix’s actors, System actor has to be created and started with System::run() call. This method creates new Arbiter in current thread and starts System actor.

Examples

extern crate actix;

use actix::prelude::*;
use std::time::Duration;

struct Timer {
    dur: Duration,
}

impl Actor for Timer {
    type Context = Context<Self>;

    // stop system after `self.dur` seconds
    fn started(&mut self, ctx: &mut Context<Self>) {
        ctx.run_later(self.dur, |act, ctx| {
            // Stop current running system.
            System::current().stop();
        });
    }
}

fn main() {
    // initialize system and run it.
    // This function blocks current thread
    let code = System::run(|| {
        // Start `Timer` actor
        Timer {
            dur: Duration::new(0, 1),
        }.start();
    });

    std::process::exit(code);
}

Implementations

impl System

pub fn builder() -> Builder

Build a new system with a customized tokio runtime.

This allows to customize the runtime. See struct level docs on Builder for more information.

pub fn new<T: Into<String>>(name: T) -> SystemRunner

Create new system.

This method panics if it can not create tokio runtime

pub fn current() -> System

Get current running system.

pub fn with_current<F, R>(f: F) -> Rwhere
    F: FnOnce(&System) -> R,

Execute function with system reference.

pub fn stop(&self)

Stop the system

pub fn stop_with_code(&self, code: i32)

Stop the system with a particular exit code.

pub fn arbiter(&self) -> &Addr<Arbiter>

System arbiter

pub fn registry(&self) -> &SystemRegistry

Get current system registry.

pub fn run<F>(f: F) -> i32where
    F: FnOnce() + 'static,

This function will start tokio runtime and will finish once the System::stop() message get called. Function f get called within tokio runtime context.

Trait Implementations

impl Clone for System

fn clone(&self) -> System

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for System

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

Formats the value using the given formatter.