Struct AsyncCustomScheduler

pub struct AsyncCustomScheduler<INSTANT, SLEEPER> { /* private fields */ }

Implementations

impl<INSTANT, SLEEPER> AsyncCustomScheduler<INSTANT, SLEEPER>

where INSTANT: Instant, SLEEPER: AsyncSleeper,

pub fn new(target_hz: f32) -> Self

where SLEEPER: Default,

Constructs a new AsyncCustomScheduler struct that can schedule tasks at the given frequency target_hz.

pub fn with_sleeper(target_hz: f32, sleeper: SLEEPER) -> Self

Constructs a new AsyncCustomScheduler struct that can schedule tasks at the given frequency target_hz.

pub fn set_hz(&mut self, new_target_hz: f32)

Allows you to change the frequency at which the scheduler tries to run tasks.

pub fn hz(&self) -> f32

Returns the frequency the AsyncCustomScheduler is currently set to.

pub async fn loop_forever(&mut self, task: impl FnMut()) -> !

Lets you run a task at a fixed interval, forever.

pub async fn loop_while_true(&mut self, task: impl FnMut() -> bool)

Lets you run a task at a fixed interval. Will break when the function returns false.

pub async fn loop_until_err<T>( &mut self, task: impl FnMut() -> Result<T, Box<dyn Error>>, ) -> Box<dyn Error>

Lets you run a task at a fixed interval. Will break when the function returns a result of Err variant.

pub async fn sleep_until_next_frame(&mut self)

Can be called manually to sleep until the next scheduled frame.

Valuable for when you’d like to avoid having to pass values into a closure, or would like more control over loop flow.

Trait Implementations

impl<INSTANT: Clone, SLEEPER: Clone> Clone for AsyncCustomScheduler<INSTANT, SLEEPER>

fn clone(&self) -> AsyncCustomScheduler<INSTANT, SLEEPER>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<INSTANT: Debug, SLEEPER: Debug> Debug for AsyncCustomScheduler<INSTANT, SLEEPER>

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

Formats the value using the given formatter.

impl<INSTANT, SLEEPER> Default for AsyncCustomScheduler<INSTANT, SLEEPER>

where INSTANT: Instant, SLEEPER: AsyncSleeper + Default,

fn default() -> Self

assumes a default hz of 60

impl<INSTANT: Hash, SLEEPER: Hash> Hash for AsyncCustomScheduler<INSTANT, SLEEPER>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<INSTANT: Copy, SLEEPER: Copy> Copy for AsyncCustomScheduler<INSTANT, SLEEPER>