Struct rosc::OscTime

pub struct OscTime {
    pub seconds: u32,
    pub fractional: u32,
}

A time tag in OSC message consists of two 32-bit integers where the first one denotes the number of seconds since 1900-01-01 and the second the fractions of a second. For details on its semantics see http://opensoundcontrol.org/node/3/#timetags

Examples

use rosc::OscTime;
use std::{convert::TryFrom, time::SystemTime};

assert_eq!(
    OscTime::try_from(SystemTime::UNIX_EPOCH).unwrap(),
    OscTime::from((2_208_988_800, 0))
);

Conversions between (u32, u32)

Prior to version 0.5.0 of this crate, OscTime was defined as a type alias to (u32, u32). If you are upgrading from one of these older versions, you can use .into() to convert between (u32, u32) and OscTime in either direction.

Conversions between std::time::SystemTime

The traits in std::convert are implemented for converting between SystemTime and OscTime in both directions. An OscTime can be converted into a SystemTime using From/Into. A SystemTime can be converted into an OscTime using TryFrom/TryInto. The fallible variants of the conversion traits are used this case because not every SystemTime can be represented as an OscTime.

These conversions are lossy, but are tested to have a deviation within 5 nanoseconds when converted back and forth in either direction.

Fields

seconds: u32

fractional: u32

Trait Implementations

impl Clone for OscTime

fn clone(&self) -> OscTime

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for OscTime

impl Debug for OscTime

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

Formats the value using the given formatter.

impl Eq for OscTime

impl From<(u32, u32)> for OscTime

fn from(time: (u32, u32)) -> OscTime

Performs the conversion.

impl Hash for OscTime

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 OscTime

fn cmp(&self, other: &OscTime) -> 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<OscTime> for OscTime

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

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

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

This method tests for !=.

impl PartialOrd<OscTime> for OscTime

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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 StructuralEq for OscTime

impl StructuralPartialEq for OscTime

impl TryFrom<SystemTime> for OscTime

type Error = OscTimeError

The type returned in the event of a conversion error.

fn try_from(time: SystemTime) -> Result<OscTime, OscTimeError>

Performs the conversion.