Skip to main content

TransitionConfig

Struct TransitionConfig 

Source
pub struct TransitionConfig {
    pub enter_ms: u32,
    pub exit_ms: u32,
}
Expand description

Configuration for a TransitionState.

Both fields are reactive (the underlying state holds a Signal<TransitionConfig>), so consumers can adjust the durations at runtime via change_config and any pending timers driven by the old config will continue using the old values until they next read the config signal.

Fields§

§enter_ms: u32

The duration of the enter animation, in milliseconds.

§exit_ms: u32

The duration of the exit animation, in milliseconds.

Implementations§

Source§

impl TransitionConfig

Inherent implementation of TransitionConfig.

Source

pub const fn with_ms(ms: u32) -> Self

Returns a config with both enter and exit durations set to ms.

Named with_ms (not new) to avoid colliding with the new constructor generated by #[derive(New)]. (We don’t derive New here because the field name enter_ms would generate a set_enter_ms setter that nobody asked for — keeping the struct Copy and writing it via TransitionConfig { enter_ms, exit_ms } is simpler.)

§Arguments
  • u32 - A 32-bit unsigned integer (u32).
Source

pub const fn with_durations(enter_ms: u32, exit_ms: u32) -> Self

Returns a config with separate enter and exit durations. See with_ms for the naming note.

§Arguments
  • u32 - A 32-bit unsigned integer (u32).
  • u32 - A 32-bit unsigned integer (u32).
Source

pub fn duration_for(&self, phase: TransitionPhase) -> u32

Returns the duration (in ms) corresponding to the given phase. Returns 0 for terminal phases (Entered, Exited) — these don’t tick.

§Arguments
  • TransitionPhase - A TransitionPhase parameter.
§Returns
  • u32 - A 32-bit unsigned integer.
Source§

impl TransitionConfig

Source

pub fn get_enter_ms(&self) -> u32

Source

pub fn get_mut_enter_ms(&mut self) -> &mut u32

Source

pub fn set_enter_ms(&mut self, val: u32) -> &mut Self

Source

pub fn get_exit_ms(&self) -> u32

Source

pub fn get_mut_exit_ms(&mut self) -> &mut u32

Source

pub fn set_exit_ms(&mut self, val: u32) -> &mut Self

Trait Implementations§

Source§

impl Clone for TransitionConfig

Source§

fn clone(&self) -> TransitionConfig

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 TransitionConfig

Source§

impl Debug for TransitionConfig

Source§

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

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

impl Default for TransitionConfig

Default-construction for TransitionConfig.

Source§

fn default() -> Self

Constructs a default TransitionConfig value.

Source§

impl Eq for TransitionConfig

Source§

impl PartialEq for TransitionConfig

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for TransitionConfig

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 = !

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

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more