[][src]Struct actix::System

pub struct System { /* fields omitted */ }

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);
}

Methods

impl System[src]

pub fn builder() -> Builder[src]

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[src]

Create new system.

This method panics if it can not create tokio runtime

pub fn current() -> System[src]

Get current running system.

pub fn with_current<F, R>(f: F) -> R where
    F: FnOnce(&System) -> R, 
[src]

Execute function with system reference.

pub fn stop(&self)[src]

Stop the system

pub fn stop_with_code(&self, code: i32)[src]

Stop the system with a particular exit code.

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

System arbiter

pub fn registry(&self) -> &SystemRegistry[src]

Get current system registry.

pub fn run<F>(f: F) -> i32 where
    F: FnOnce() + 'static, 
[src]

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[src]

fn clone_from(&mut self, source: &Self)
1.0.0
[src]

Performs copy-assignment from source. Read more

impl Debug for System[src]

Auto Trait Implementations

impl Send for System

impl Sync for System

Blanket Implementations

impl<T> From for T[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

type Error = !

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Erased for T