Struct kira::clock::ClockHandle

pub struct ClockHandle { /* private fields */ }

Controls a clock.

When a ClockHandle is dropped, the corresponding clock will be removed.

Implementations

impl ClockHandle

pub fn id(&self) -> ClockId

Returns the unique identifier for the clock.

pub fn ticking(&self) -> bool

Returns true if the clock is currently ticking and false if not.

pub fn time(&self) -> ClockTime

Returns the current time of the clock.

pub fn set_speed(
    &mut self,
    speed: impl Into<ClockSpeed>,
    tween: Tween
) -> Result<(), CommandError>

Sets the speed of the clock.

pub fn start(&mut self) -> Result<(), CommandError>

Starts or resumes the clock.

pub fn pause(&mut self) -> Result<(), CommandError>

Pauses the clock.

pub fn stop(&mut self) -> Result<(), CommandError>

Stops and resets the clock.

Trait Implementations

impl Drop for ClockHandle

fn drop(&mut self)

Executes the destructor for this type.

impl From<&'_ ClockHandle> for ClockId

fn from(handle: &ClockHandle) -> Self

Performs the conversion.