Struct Progress 

pub struct Progress(/* private fields */);

A motion’s presentation progress, normally between zero and one.

Motion::sample returns progress after the easing function has run. An easing curve may overshoot, so a sample can fall outside 0.0..=1.0. Use Progress::clamped when an API needs that range. Progress describes where the presentation is, not whether the run has finished; use MotionSample::is_complete for that.

Examples

use gpui::Progress;

assert_eq!(Progress::clamped(1.5), Progress::END);
assert_eq!(Progress::clamped(-0.25), Progress::START);
assert_eq!(Progress::clamped(0.5).get(), 0.5);

Implementations

impl Progress

pub const START: Self

Zero progress: the origin of a motion.

pub const END: Self

One progress: the target of a motion.

pub fn clamped(value: f32) -> Self

Returns value limited to 0.0..=1.0.

Panics

Panics if value is NaN.

pub const fn get(self) -> f32

Returns the progress as a float. It can lie outside 0.0..=1.0 when it comes from an easing curve that overshoots.

pub const fn is_at_end(self) -> bool

Returns whether the progress is exactly one.

This doesn’t mean the whole run has finished. Use MotionSample::is_complete for that.

Trait Implementations

impl Clone for Progress

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Progress

impl Debug for Progress

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

Formats the value using the given formatter.

impl Default for Progress

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Progress

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Progress

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Progress