freya_animation::hook

Struct UseAnimation

Source 
pub struct UseAnimation<Animated: AnimatedValue> { /* private fields */ }
Expand description

Animate your elements. Use use_animation to use this.

Implementations§

Source§

impl<Animated: AnimatedValue> UseAnimation<Animated>

Source

pub fn get(&self) -> ReadRef<'static, Animated>

Get the animated value.

Source

pub fn start(&mut self)

Runs the animation normally.

Source

pub fn reverse(&mut self)

Runs the animation in reverse direction.

Source

pub fn finish(&mut self)

Finish the animation with the final state.

Source

pub fn has_run_yet(&self) -> State<bool>

Source

pub fn run(&self, direction: AnimDirection)

Run the animation with a given AnimDirection

Methods from Deref<Target = State<Animated>>§

Source

pub fn read(&self) -> <UnsyncStorage as AnyStorage>::Ref<'static, T>

Source

pub fn peek(&self) -> <UnsyncStorage as AnyStorage>::Ref<'static, T>

Source

pub fn write_unchecked(&self) -> <UnsyncStorage as AnyStorage>::Mut<'static, T>

Trait Implementations§

Source§

impl<Animated: Clone + AnimatedValue> Clone for UseAnimation<Animated>

Source§

fn clone(&self) -> UseAnimation<Animated>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<Animated: AnimatedValue> Deref for UseAnimation<Animated>

Source§

type Target = State<Animated>

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl<Animated: PartialEq + AnimatedValue> PartialEq for UseAnimation<Animated>

Source§

fn eq(&self, other: &UseAnimation<Animated>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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<T: AnimatedValue> Copy for UseAnimation<T>

Source§

impl<Animated: AnimatedValue> StructuralPartialEq for UseAnimation<Animated>

Auto Trait Implementations§

§

impl<Animated> Freeze for UseAnimation<Animated>

§

impl<Animated> !RefUnwindSafe for UseAnimation<Animated>

§

impl<Animated> !Send for UseAnimation<Animated>

§

impl<Animated> !Sync for UseAnimation<Animated>

§

impl<Animated> Unpin for UseAnimation<Animated>
where Animated: Unpin,

§

impl<Animated> !UnwindSafe for UseAnimation<Animated>

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> ComponentProps for T
where T: Any + PartialEq,

Source§

fn changed(&self, other: &(dyn ComponentProps + 'static)) -> bool

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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 more
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more