Struct Timestamp

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

Available on crate feature timestamp only.

RFC3339 timestamp

Implementations

impl Timestamp

pub fn new(raw: String) -> Result<Self, TimestampParseError>

Constructs a new Timestamp if it conforms to Timestamp

pub const unsafe fn new_unchecked(raw: String) -> Self

Constructs a new Timestamp without validation

Safety

Consumers of this function must ensure that values conform to Timestamp. Failure to maintain this invariant may lead to undefined behavior.

pub fn from_static(raw: &'static str) -> Self

Constructs a new Timestamp from a static reference if it conforms to Timestamp

Panics

This function will panic if the provided raw string is not valid.

pub fn into_boxed_ref(self) -> Box<TimestampRef>

Converts this Timestamp into a Box<TimestampRef>

This will drop any excess capacity.

pub fn take(self) -> String

Unwraps the underlying String value

impl Timestamp

pub fn now() -> Timestamp

Available on crate feature time only.

Create a timestamp corresponding to current time

pub fn today() -> Timestamp

Available on crate feature time only.

Create a timestamp corresponding to the start of the current day. Timezone will always be UTC.

Methods from Deref<Target = TimestampRef>

pub fn as_str(&self) -> &str

Provides access to the underlying value as a string slice.

pub fn as_cow(&self) -> Cow<'_, TimestampRef>

Get a Cow<'_, TimestampRef>

pub fn normalize(&self) -> Result<Cow<'_, TimestampRef>, TimestampParseError>

Normalize the timestamp into UTC time.

Examples

use twitch_types::Timestamp;

let time = Timestamp::try_from("2021-07-01T13:37:00Z")?;
assert_eq!(time.normalize()?.as_ref(), &time);
let time2 = Timestamp::try_from("2021-07-01T13:37:00-01:00")?;
assert_ne!(time2.normalize()?.as_ref(), &time2);

pub fn is_before<T: ?Sized>(&self, other: &T) -> bool

where Self: PartialOrd<T>,

Compare another time and return self < other.

Examples

use twitch_types::Timestamp;

let time2021 = Timestamp::try_from("2021-07-01T13:37:00Z").unwrap();
let time2020 = Timestamp::try_from("2020-07-01T13:37:00Z").unwrap();
assert!(time2020.is_before(&time2021));

pub fn to_day(&self) -> Timestamp

Make a timestamp with the time component set to 00:00:00.

Examples

use twitch_types::Timestamp;

let time = Timestamp::try_from("2021-07-01T13:37:00Z").unwrap();
assert_eq!(time.to_day().as_str(), "2021-07-01T00:00:00Z");

pub fn year(&self) -> &str

Get the year

Examples

use twitch_types::Timestamp;

let time = Timestamp::try_from("2021-07-01T13:37:00Z").unwrap();
assert_eq!(time.year(), "2021");

pub fn month(&self) -> &str

Get the month

Examples

use twitch_types::Timestamp;

let time = Timestamp::try_from("2021-07-01T13:37:00Z").unwrap();
assert_eq!(time.month(), "07");

pub fn day(&self) -> &str

Get the day

Examples

use twitch_types::Timestamp;

let time = Timestamp::try_from("2021-07-01T13:37:00Z").unwrap();
assert_eq!(time.day(), "01");

pub fn hour(&self) -> &str

Get the hour

Examples

use twitch_types::Timestamp;

let time = Timestamp::try_from("2021-07-01T13:37:00Z").unwrap();
assert_eq!(time.hour(), "13");

pub fn minute(&self) -> &str

Get the minute

Examples

use twitch_types::Timestamp;

let time = Timestamp::try_from("2021-07-01T13:37:00Z").unwrap();
assert_eq!(time.minute(), "37");

pub fn second(&self) -> &str

Get the second

Examples

use twitch_types::Timestamp;

let time = Timestamp::try_from("2021-07-01T13:37:00Z").unwrap();
assert_eq!(time.second(), "00");

pub fn millis(&self) -> Option<&str>

Get the millis

Examples

use twitch_types::Timestamp;

let time = Timestamp::try_from("2021-07-01T13:37:00.123Z").unwrap();
assert_eq!(time.millis(), Some("123"));
let time = Timestamp::try_from("2021-07-01T13:37:00Z").unwrap();
assert_eq!(time.millis(), None);

pub fn to_utc(&self) -> OffsetDateTime

Available on crate feature time only.

Construct into a OffsetDateTime time with a guaranteed UTC offset.

Panics

This method assumes the timestamp is a valid rfc3339 timestamp, and panics if not.

pub fn to_fixed_offset(&self) -> OffsetDateTime

Available on crate feature time only.

Construct into a OffsetDateTime time.

Panics

This method assumes the timestamp is a valid rfc3339 timestamp, and panics if not.

Trait Implementations

impl AsRef<TimestampRef> for Timestamp

fn as_ref(&self) -> &TimestampRef

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for Timestamp

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<TimestampRef> for Timestamp

fn borrow(&self) -> &TimestampRef

Immutably borrows from an owned value.

impl Borrow<str> for Timestamp

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for Timestamp

fn clone(&self) -> Timestamp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Timestamp

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

Formats the value using the given formatter.

impl Deref for Timestamp

type Target = TimestampRef

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for Timestamp

Available on crate feature serde only.

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Timestamp

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

Formats the value using the given formatter.

impl<'a> From<&'a Timestamp> for &'a TimestampRef

fn from(owned: &'a Timestamp) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Timestamp> for Cow<'a, TimestampRef>

fn from(owned: &'a Timestamp) -> Self

Converts to this type from the input type.

impl From<&TimestampRef> for Timestamp

fn from(s: &TimestampRef) -> Self

Converts to this type from the input type.

impl From<Box<TimestampRef>> for Timestamp

fn from(r: Box<TimestampRef>) -> Self

Converts to this type from the input type.

impl<'a> From<Cow<'a, TimestampRef>> for Timestamp

fn from(r: Cow<'a, TimestampRef>) -> Self

Converts to this type from the input type.

impl From<Timestamp> for Box<TimestampRef>

fn from(r: Timestamp) -> Self

Converts to this type from the input type.

impl From<Timestamp> for Cow<'_, TimestampRef>

fn from(owned: Timestamp) -> Self

Converts to this type from the input type.

impl From<Timestamp> for String

fn from(s: Timestamp) -> Self

Converts to this type from the input type.

impl FromStr for Timestamp

type Err = TimestampParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Timestamp

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> IntoCow<'a, TimestampRef> for &'a Timestamp

fn into_cow(self) -> Cow<'a, TimestampRef>

Make the cow with proper ownership, muu

impl<'a> IntoCow<'a, TimestampRef> for Timestamp

fn into_cow(self) -> Cow<'a, TimestampRef>

Make the cow with proper ownership, muu

impl PartialEq<&TimestampRef> for Timestamp

fn eq(&self, other: &&TimestampRef) -> 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 PartialEq<OffsetDateTime> for Timestamp

Available on crate feature time only.

fn eq(&self, other: &OffsetDateTime) -> 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 PartialEq<Timestamp> for &TimestampRef

fn eq(&self, other: &Timestamp) -> 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 PartialEq<Timestamp> for TimestampRef

fn eq(&self, other: &Timestamp) -> 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 PartialEq<TimestampRef> for Timestamp

fn eq(&self, other: &TimestampRef) -> 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 PartialEq for Timestamp

fn eq(&self, other: &Timestamp) -> 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<OffsetDateTime> for Timestamp

Available on crate feature time only.

fn partial_cmp(&self, other: &OffsetDateTime) -> 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 PartialOrd<Timestamp> for TimestampRef

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

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 Serialize for Timestamp

Available on crate feature serde only.

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for Timestamp

type Error = TimestampParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<OffsetDateTime> for Timestamp

Available on crate feature time only.

type Error = Format

The type returned in the event of a conversion error.

fn try_from(value: OffsetDateTime) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for Timestamp

type Error = TimestampParseError

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Timestamp

impl StructuralPartialEq for Timestamp