Skip to main content

Scheduler

Struct Scheduler 

Source
pub struct Scheduler<W> {
    pub budget_warnings: u64,
    /* private fields */
}
Expand description

The frame scheduler: runs registered systems in order, tracks frame time.

Fields§

§budget_warnings: u64

How many times the sustained-overrun warning has fired. Read by tests and the observability cross-cut (book T15).

Implementations§

Source§

impl<W> Scheduler<W>

Source

pub fn new() -> Self

Source

pub fn with_budget_ns(budget_ns: u64) -> Self

Build a scheduler graded against a specific frame budget (ns).

Source

pub fn add_system(&mut self, s: Box<dyn System<W>>)

Source

pub fn budget_ms(&self) -> f32

The configured frame budget in ms.

Source

pub fn system_timings(&self) -> &[(String, f32)]

Per-system wall time of the last frame, in run order: [(name, ms), ...]. Updated by every Scheduler::tick.

Source

pub fn tick(&mut self, world: &mut W) -> f32

Run one frame. Returns the measured frame time in ms.

Source

pub fn avg_frame_ms(&self) -> f32

Mean frame time over the last 60 frames, in ms.

Trait Implementations§

Source§

impl<W> Default for Scheduler<W>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<W> !RefUnwindSafe for Scheduler<W>

§

impl<W> !Send for Scheduler<W>

§

impl<W> !Sync for Scheduler<W>

§

impl<W> !UnwindSafe for Scheduler<W>

§

impl<W> Freeze for Scheduler<W>
where Vec<Box<dyn System<W>>>: Freeze,

§

impl<W> Unpin for Scheduler<W>
where Vec<Box<dyn System<W>>>: Unpin,

§

impl<W> UnsafeUnpin for Scheduler<W>
where Vec<Box<dyn System<W>>>: UnsafeUnpin,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more