Struct Timespec

#[repr(C)]
pub struct Timespec {
    pub tv_sec: Secs,
    pub tv_nsec: Nsecs,
}

Available on crate feature fs only.

struct timespec

Fields

tv_sec: Secs

Seconds.

tv_nsec: Nsecs

Nanoseconds. Must be less than 1_000_000_000.

When passed to rustix::fs::utimensat, this field may instead be assigned the values UTIME_NOW or UTIME_OMIT.

Implementations

impl Timespec

pub const fn checked_add(self, rhs: Self) -> Option<Self>

Checked Timespec addition. Returns None if overflow occurred.

Panics

If 0 <= .tv_nsec < 1_000_000_000 doesn’t hold, this function may panic or return unexpected results.

Example

use rustix::event::Timespec;

assert_eq!(
    Timespec {
        tv_sec: 1,
        tv_nsec: 2
    }
    .checked_add(Timespec {
        tv_sec: 30,
        tv_nsec: 40
    }),
    Some(Timespec {
        tv_sec: 31,
        tv_nsec: 42
    })
);
assert_eq!(
    Timespec {
        tv_sec: 0,
        tv_nsec: 999_999_999
    }
    .checked_add(Timespec {
        tv_sec: 0,
        tv_nsec: 2
    }),
    Some(Timespec {
        tv_sec: 1,
        tv_nsec: 1
    })
);
assert_eq!(
    Timespec {
        tv_sec: i64::MAX,
        tv_nsec: 999_999_999
    }
    .checked_add(Timespec {
        tv_sec: 0,
        tv_nsec: 1
    }),
    None
);

pub const fn checked_sub(self, rhs: Self) -> Option<Self>

Checked Timespec subtraction. Returns None if overflow occurred.

Panics

If 0 <= .tv_nsec < 1_000_000_000 doesn’t hold, this function may panic or return unexpected results.

Example

use rustix::event::Timespec;

assert_eq!(
    Timespec {
        tv_sec: 31,
        tv_nsec: 42
    }
    .checked_sub(Timespec {
        tv_sec: 30,
        tv_nsec: 40
    }),
    Some(Timespec {
        tv_sec: 1,
        tv_nsec: 2
    })
);
assert_eq!(
    Timespec {
        tv_sec: 1,
        tv_nsec: 1
    }
    .checked_sub(Timespec {
        tv_sec: 0,
        tv_nsec: 2
    }),
    Some(Timespec {
        tv_sec: 0,
        tv_nsec: 999_999_999
    })
);
assert_eq!(
    Timespec {
        tv_sec: i64::MIN,
        tv_nsec: 0
    }
    .checked_sub(Timespec {
        tv_sec: 0,
        tv_nsec: 1
    }),
    None
);

Trait Implementations

impl Add for Timespec

type Output = Timespec

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Timespec

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Timespec

fn clone(&self) -> Timespec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Timespec

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

Formats the value using the given formatter.

impl Default for Timespec

fn default() -> Timespec

Returns the “default value” for a type.

impl Neg for Timespec

type Output = Timespec

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl Ord for Timespec

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Timespec

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Timespec

fn partial_cmp(&self, other: &Timespec) -> 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 Sub for Timespec

type Output = Timespec

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Timespec

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl TryFrom<Duration> for Timespec

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(dur: Duration) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Timespec> for Duration

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(ts: Timespec) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Timespec

impl Eq for Timespec

impl StructuralPartialEq for Timespec