Skip to main content

Timing

Struct Timing 

Source
pub struct Timing { /* private fields */ }
Expand description

Timing configuration shared by duration-based animations.

§Examples

use aura_anim_core::timing::{Delay, Direction, Easing, Timing};

let timing = Timing::new(250.0)
    .with_delay(Delay::from_millis(50.0))
    .with_easing(Easing::EaseOut)
    .with_direction(Direction::Alternate)
    .with_iterations(2);

assert_eq!(timing.duration().as_millis(), 250.0);
assert_eq!(timing.total_duration().unwrap().as_millis(), 550.0);

Implementations§

Source§

impl Timing

Source

pub fn new(duration_ms: f64) -> Self

Creates a timing value with a duration in milliseconds.

Source

pub const fn duration(&self) -> Duration

Returns the duration of the timing.

Source

pub const fn delay(&self) -> Delay

Returns the delay of the timing.

Source

pub const fn direction(&self) -> Direction

Returns the direction of the timing.

Source

pub const fn easing(&self) -> Easing

Returns the easing curve of the timing.

Source

pub const fn iterations(&self) -> IterationCount

Returns the number of iterations of the timing.

Source

pub const fn with_delay(self, delay: Delay) -> Self

Sets the start delay.

Source

pub const fn with_direction(self, direction: Direction) -> Self

Sets the playback direction.

Source

pub const fn with_easing(self, easing: Easing) -> Self

Sets the easing curve.

Source

pub fn with_iterations(self, iterations: impl Into<IterationCount>) -> Self

Sets the iteration count.

Source

pub fn active_duration(self) -> Option<Duration>

Returns the total active duration when the timing has a finite length.

Source

pub fn total_duration(self) -> Option<Duration>

Returns the total duration including delay when finite.

Trait Implementations§

Source§

impl Clone for Timing

Source§

fn clone(&self) -> Timing

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Timing

Source§

impl Debug for Timing

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Timing

Source§

fn default() -> Self

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

impl PartialEq for Timing

Source§

fn eq(&self, other: &Timing) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Timing

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

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 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.