Struct freya_hooks::UseAnimator
source · pub struct UseAnimator<Animated: PartialEq + Clone + 'static> { /* private fields */ }
Expand description
Animate your elements. Use use_animation
to use this.
Implementations§
source§impl<Animated: PartialEq + Clone + 'static> UseAnimator<Animated>
impl<Animated: PartialEq + Clone + 'static> UseAnimator<Animated>
sourcepub fn is_running(&self) -> bool
pub fn is_running(&self) -> bool
Checks if there is any animation running.
sourcepub fn has_run_yet(&self) -> bool
pub fn has_run_yet(&self) -> bool
Checks if it has run yet, by subscribing.
sourcepub fn peek_has_run_yet(&self) -> bool
pub fn peek_has_run_yet(&self) -> bool
Checks if it has run yet, doesn’t subscribe. Useful for when you just mounted your component.
sourcepub fn run(&self, direction: AnimDirection)
pub fn run(&self, direction: AnimDirection)
Run the animation with a given AnimDirection
Trait Implementations§
source§impl<Animated: Clone + PartialEq + Clone + 'static> Clone for UseAnimator<Animated>
impl<Animated: Clone + PartialEq + Clone + 'static> Clone for UseAnimator<Animated>
source§fn clone(&self) -> UseAnimator<Animated>
fn clone(&self) -> UseAnimator<Animated>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl<Animated: PartialEq + PartialEq + Clone + 'static> PartialEq for UseAnimator<Animated>
impl<Animated: PartialEq + PartialEq + Clone + 'static> PartialEq for UseAnimator<Animated>
source§fn eq(&self, other: &UseAnimator<Animated>) -> bool
fn eq(&self, other: &UseAnimator<Animated>) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.impl<T: PartialEq + Clone + 'static> Copy for UseAnimator<T>
impl<Animated: PartialEq + Clone + 'static> StructuralPartialEq for UseAnimator<Animated>
Auto Trait Implementations§
impl<Animated> Freeze for UseAnimator<Animated>
impl<Animated> !RefUnwindSafe for UseAnimator<Animated>
impl<Animated> !Send for UseAnimator<Animated>
impl<Animated> !Sync for UseAnimator<Animated>
impl<Animated> Unpin for UseAnimator<Animated>where
Animated: Unpin,
impl<Animated> !UnwindSafe for UseAnimator<Animated>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<T, O> SuperFrom<T> for Owhere
O: From<T>,
impl<T, O> SuperFrom<T> for Owhere
O: From<T>,
source§fn super_from(input: T) -> O
fn super_from(input: T) -> O
Convert from a type to another type.
source§impl<T, O, M> SuperInto<O, M> for Twhere
O: SuperFrom<T, M>,
impl<T, O, M> SuperInto<O, M> for Twhere
O: SuperFrom<T, M>,
source§fn super_into(self) -> O
fn super_into(self) -> O
Convert from a type to another type.