Struct System 

pub struct System(/* private fields */);

Runtime manager for a group of arbiter threads.

A system stores runtime configuration, manages arbiters, dispatches process signals, and owns the blocking thread pool.

Implementations

impl System

pub fn build() -> Builder

Creates a builder for a system with a customized runtime.

See Builder for the available configuration options.

pub fn new<R: Runner>(name: &str, runner: R) -> SystemRunner

Creates a system runner with the specified name and runtime runner.

Panics

Panics if the runtime cannot be created.

pub fn with_config(name: &str, config: SystemConfig) -> SystemRunner

Creates a system runner from an existing configuration.

Panics

Panics if the runtime cannot be created.

pub fn current() -> System

Returns the system running on the current thread.

Panics

Panics if no system is running on the current thread.

pub fn try_current() -> Option<System>

Returns the system running on the current thread, if one exists.

pub fn id(&self) -> Id

Returns the system identifier.

pub fn name(&self) -> &str

Returns the system name.

pub fn stop(&self)

Stops the system with exit code 0.

pub fn stop_with_code(&self, code: i32)

Stops the system with the specified exit code.

pub fn signals(&self) -> bool

Returns whether process signal handling is enabled.

pub fn enable_signals(&self)

Enables process signal handling.

pub fn disable_signals(&self)

Disables process signal handling.

pub fn arbiter(&self) -> Arbiter

Returns the system’s primary arbiter.

Panics

Panics if the system has not been started.

pub fn list_arbiters<F, R>(&self, f: F) -> R

where F: FnOnce(&[Arbiter]) -> R,

Provides access to all arbiters registered with this system.

This method should be called from the thread where the system has been initialized, typically the “main” thread.

pub fn list_arbiter_pings<F>(f: F)

where F: FnMut(&Arbiter, &mut VecDeque<PingRecord>),

Visits the latest ping records for each registered arbiter.

This method should be called from the thread where the system has been initialized, typically the “main” thread.

pub fn config(&self) -> SystemConfig

Returns a clone of the system configuration.

pub fn handle(&self) -> Handle

Returns a runtime handle for the primary arbiter.

pub fn testing(&self) -> bool

Returns whether the system is configured for testing.

pub fn spawn_blocking<F, R>(&self, f: F) -> BlockingResult<R>

where F: FnOnce() -> R + Send + 'static, R: Send + 'static,

Spawns a blocking task on a new thread and waits for it to complete.

Dropping the returned future prevents queued work from starting, but cannot interrupt work that is already running. Call BlockingResult::detach to let queued work continue even if its result is no longer needed.

pub fn get_value<T>(&self, f: impl FnOnce() -> T) -> T

where T: Clone + Send + Sync + 'static,

Returns a previously registered type, or inserts and returns a new one.

This method acquires a lock on the internal data structure. To avoid repeated locking, prefer storing a cloned value in the arbiter’s storage.

Trait Implementations

impl Clone for System

fn clone(&self) -> Self

Returns a duplicate 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.