Struct sfml::system::Time

pub struct Time(_);

Represents a time value.

Time encapsulates a time value in a flexible way.

It allows to define a time value either as a number of seconds, milliseconds or microseconds. It also works the other way round: you can read a time value as either a number of seconds, milliseconds or microseconds.

By using such a flexible interface, the API doesn’t impose any fixed type or resolution for time values, and let the user choose its own favorite representation.

Time values support the usual mathematical operations: you can add or subtract two times, multiply or divide a time by a number, compare two times, etc.

Since they represent a time span and not an absolute time value, times can also be negative.

Usage example

let t1 = Time::seconds(0.1);
assert_eq!(t1.as_milliseconds(), 100);

let t2 = Time::milliseconds(30);
assert_eq!(t2.as_microseconds(), 30_000);

let t3 = Time::microseconds(-800_000);
assert_eq!(t3.as_seconds(), -0.8);

See also

• Clock

Implementations

impl Time

pub fn seconds(seconds: f32) -> Self

Constructs a time value from a number of seconds.

pub const fn milliseconds(milliseconds: i32) -> Self

Constructs a time value from a number of milliseconds.

pub const fn microseconds(microseconds: i64) -> Self

Constructs a time value from a number of microseconds.

pub fn as_seconds(self) -> f32

Returns the time value as a number of seconds.

pub fn as_milliseconds(self) -> i32

Returns the time value as a number of milliseconds.

pub fn as_microseconds(self) -> i64

Returns the time value as a number of microseconds.

pub const ZERO: Time = _

Predefined “zero” time value.

Trait Implementations

impl Add<Time> for Time

type Output = Time

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self

Performs the + operation.

impl AddAssign<Time> for Time

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Time

fn clone(&self) -> Time

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Time

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

Formats the value using the given formatter.

impl Default for Time

fn default() -> Self

Returns the “default value” for a type.

impl Div<Time> for Time

fn div(self, rhs: Self) -> f32

Overload of binary / operator to compute the ratio of two time values.

type Output = f32

The resulting type after applying the / operator.

impl Div<f32> for Time

fn div(self, rhs: f32) -> Self

Overload of binary / operator to scale a time value.

type Output = Time

The resulting type after applying the / operator.

impl Div<i64> for Time

fn div(self, rhs: i64) -> Self

Overload of binary / operator to scale a time value.

type Output = Time

The resulting type after applying the / operator.

impl DivAssign<f32> for Time

fn div_assign(&mut self, rhs: f32)

Overload of binary /= operator to scale/assign a time value.

impl DivAssign<i64> for Time

fn div_assign(&mut self, rhs: i64)

Overload of binary /= operator to scale/assign a time value.

impl Mul<Time> for f32

fn mul(self, rhs: Time) -> Time

Overload of binary * operator to scale a time value.

type Output = Time

The resulting type after applying the * operator.

impl Mul<Time> for i64

fn mul(self, rhs: Time) -> Time

Overload of binary * operator to scale a time value.

type Output = Time

The resulting type after applying the * operator.

impl Mul<f32> for Time

fn mul(self, rhs: f32) -> Self

Overload of binary * operator to scale a time value.

type Output = Time

The resulting type after applying the * operator.

impl Mul<i64> for Time

fn mul(self, rhs: i64) -> Self

Overload of binary * operator to scale a time value.

type Output = Time

The resulting type after applying the * operator.

impl MulAssign<f32> for Time

fn mul_assign(&mut self, rhs: f32)

Overload of binary *= operator to scale/assign a time value.

impl MulAssign<i64> for Time

fn mul_assign(&mut self, rhs: i64)

Overload of binary *= operator to scale/assign a time value.

impl Neg for Time

type Output = Time

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl Ord for Time

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Time> for Time

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Time> for Time

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

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

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

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

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

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

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

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

impl Rem<Time> for Time

type Output = Time

The resulting type after applying the % operator.

fn rem(self, rhs: Self) -> Self

Performs the % operation.

impl RemAssign<Time> for Time

fn rem_assign(&mut self, rhs: Self)

Performs the %= operation.

impl Sub<Time> for Time

type Output = Time

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self

Performs the - operation.

impl SubAssign<Time> for Time

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for Time

impl Eq for Time