Struct scribl_curves::TimeSpan

pub struct TimeSpan { /* fields omitted */ }

An interval of times.

Implementations

impl TimeSpan

pub fn new(start: Time, end: Time) -> TimeSpan

Creates a new TimeSpan representing the closed interval [start, end].

Panics

Panics if start > end.

pub fn start(&self) -> Time

The starting time of this TimeSpan.

pub fn end(&self) -> Time

The ending time of this TimeSpan.

pub fn interpolate_to(&self, time: Time, other: TimeSpan) -> Time

Interpolates from a time in this timespan to a time in other.

Panics

Panics if time doesn't belong to this TimeSpan.

Example

use scribl_curves::{Time, TimeSpan};
let me = TimeSpan::new(Time::from_micros(0), Time::from_micros(100));
let other = TimeSpan::new(Time::from_micros(0), Time::from_micros(10));

assert_eq!(me.interpolate_to(Time::from_micros(50), other), Time::from_micros(5));
assert_eq!(me.interpolate_to(Time::from_micros(59), other), Time::from_micros(5));
assert_eq!(me.interpolate_to(Time::from_micros(78), other), Time::from_micros(7));

Trait Implementations

impl Clone for TimeSpan

fn clone(&self) -> TimeSpan

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for TimeSpan

impl Data for TimeSpan

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

Determine whether two values are the same.

impl Debug for TimeSpan

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TimeSpan

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for TimeSpan

impl Hash for TimeSpan

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for TimeSpan

fn cmp(&self, other: &TimeSpan) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<TimeSpan> for TimeSpan

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<TimeSpan> for TimeSpan

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for TimeSpan

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for TimeSpan

impl StructuralPartialEq for TimeSpan