Struct actix_rt::System

pub struct System { /* fields omitted */ }

System is a runtime manager.

Methods

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 run_in_tokio<T: Into<String>>(
    name: T,
    local: &LocalSet
) -> impl Future<Output = Result<()>>

Create new system using provided tokio Handle.

This method panics if it can not spawn system arbiter

pub fn current() -> System

Get current running system.

pub fn is_set() -> bool

Check if current system is set, i.e., as already been started.

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

Execute function with system reference.

pub fn id(&self) -> usize

System id

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 stop_on_panic(&self) -> bool

Return status of 'stop_on_panic' option which controls whether the System is stopped when an uncaught panic is thrown from a worker thread.

pub fn arbiter(&self) -> &Arbiter

System arbiter

pub fn run<F>(f: F) -> Result<()> where
    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.