Struct basalt::interval::Interval

source ·
pub struct Interval { /* private fields */ }
Expand description

The main struct for the interval system.

Accessed via basalt.interval_ref() or basalt.interval().

Implementations§

source§

impl Interval

source

pub fn do_every<F: FnMut(Option<Duration>) -> IntvlHookCtrl + Send + 'static>( &self, every: Duration, delay: Option<Duration>, method: F ) -> IntvlHookID

Call the method at provided internval.

Takes a Fn(last_call: Option<Duration>) -> IntvlHookCtrl.

  • last_call: Duration since the last method was called.
  • delay: is the duration that has to elapsed after Interval::start(...) before the hook method is called.
  • IntvlHookCtrl: controls how the hook is handled after the method is called.
Notes
  • Hooks are paused to begin with. They must be started with Interval::start(...).
  • last_call will only be Some if the method is called continuously. Returning InputHookCtrl::Pause or using Interval::pause(...) will cause the next call to be None.
source

pub fn pause(&self, id: IntvlHookID)

Pause a hook.

Notes
  • If hook doesn’t exist this does nothing.
source

pub fn start(&self, id: IntvlHookID)

Start a hook.

Notes
  • If hook doesn’t exist this does nothing.
source

pub fn remove(&self, id: IntvlHookID)

Remove a hook.

Notes
  • If hook doesn’t exist this does nothing.

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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, U> Into<U> for Twhere 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.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

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

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

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.