Struct SystemRunner

pub struct SystemRunner { /* private fields */ }

Runner that keeps a System’s event loop alive until stop message is received.

Implementations

impl SystemRunner

pub fn run(self) -> Result<(), Error>

Starts event loop and will return once System is stopped.

pub fn run_with_code(self) -> Result<i32, Error>

Runs the event loop until stopped, returning the exit code.

pub fn runtime(&self) -> &Runtime

Retrieves a reference to the underlying Actix runtime associated with this SystemRunner instance.

The Actix runtime is responsible for managing the event loop for an Actix system and executing asynchronous tasks. This method provides access to the runtime, allowing direct interaction with its features.

In a typical use case, you might need to share the same runtime between different parts of your project. For example, some components might require a Runtime to spawn tasks on the same runtime.

Read more in the documentation for Runtime.

Examples

let system_runner = actix_rt::System::new();
let actix_runtime = system_runner.runtime();

// Use the runtime to spawn an async task or perform other operations

Note

While this method provides an immutable reference to the Actix runtime, which is safe to share across threads, be aware that spawning blocking tasks on the Actix runtime could potentially impact system performance. This is because the Actix runtime is responsible for driving the system, and blocking tasks could delay other tasks in the run loop.

pub fn block_on<F>(&self, fut: F) -> <F as Future>::Output

where F: Future,

Runs the provided future, blocking the current thread until the future completes.

Trait Implementations

impl Debug for SystemRunner

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

Formats the value using the given formatter.