Struct fibers::fiber::Scheduler

pub struct Scheduler { /* fields omitted */ }

Scheduler of spawned fibers.

Scheduler manages spawned fibers state. If a fiber is in runnable state (e.g., not waiting for I/O events), the scheduler will push the fiber in it's run queue. When run_once method is called, the first fiber (i.e., future) in the queue will be poped and executed (i.e., Future::poll method is called). If the future of a fiber moves to readied state, it will be removed from the scheduler. For efficiency reasons, it is recommended to run a scheduler on a dedicated thread.

Methods

impl Scheduler

pub fn new(poller: PollerHandle) -> Self

Creates a new scheduler instance.

pub fn scheduler_id(&self) -> SchedulerId

Returns the identifier of this scheduler.

pub fn run_queue_len(&self) -> usize

Returns the length of the run queue of this scheduler.

pub fn fiber_count(&self) -> usize

Returns the count of alive fibers (i.e., not readied futures) in this scheduler.

pub fn handle(&self) -> SchedulerHandle

Returns a handle of this scheduler.

pub fn run_once(&mut self, block_if_idle: bool)

Runs one unit of works.

Trait Implementations

impl Debug for Scheduler

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

Formats the value using the given formatter.