Skip to main content

CountdownWait

Struct CountdownWait 

Source
pub struct CountdownWait<'a> { /* private fields */ }
Expand description

A blocking wait that reports the time left every tick and stops early when a CancelToken is cancelled.

Time is counted from the sleeps themselves, so an injected sleeper makes the wait instant and deterministic:

use std::time::Duration;
use rich_ext::countdown::{CountdownWait, WaitOutcome};

let mut ticks = Vec::new();
let outcome = CountdownWait::new(Duration::from_secs(2))
    .tick(Duration::from_secs(1))
    .sleeper(|_| {})
    .run(|left| ticks.push(left.as_secs()));
assert_eq!(outcome, WaitOutcome::Elapsed);
assert_eq!(ticks, [2, 1, 0]);

Implementations§

Source§

impl<'a> CountdownWait<'a>

Source

pub fn new(total: Duration) -> Self

Wait total, ticking every 250 ms with std::thread::sleep.

Source

pub fn tick(self, tick: Duration) -> Self

Report (and check for cancellation) every tick (at least 1 ms).

Source

pub fn cancel(self, token: CancelToken) -> Self

Stop early once token is cancelled.

Source

pub fn sleeper(self, sleep: impl FnMut(Duration) + 'a) -> Self

Sleep with sleep instead of std::thread::sleep.

Source

pub fn run(self, on_tick: impl FnMut(Duration)) -> WaitOutcome

Wait, calling on_tick with the time left before each sleep and once with zero at the end.

Source

pub fn run_live<W: Write, R: Renderable>( self, live: &mut LiveCoordinator<W>, target: &RenderTarget, motion: Motion, frame: impl Fn(Duration) -> R, ) -> Result<WaitOutcome, LiveError>

Wait while showing frame(time_left) through live.

Motion::Animated draws the frame in a new region, updates it every tick and removes it at the end. Motion::Static prints the first frame once as an ordinary line, which a log keeps.

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for CountdownWait<'a>

§

impl<'a> !Send for CountdownWait<'a>

§

impl<'a> !Sync for CountdownWait<'a>

§

impl<'a> !UnwindSafe for CountdownWait<'a>

§

impl<'a> Freeze for CountdownWait<'a>

§

impl<'a> Unpin for CountdownWait<'a>

§

impl<'a> UnsafeUnpin for CountdownWait<'a>

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