Struct twitch_api2::types::TimestampRef

#[repr(transparent)]
pub struct TimestampRef(_);

A reference to a borrowed Timestamp

Implementations

impl TimestampRef

pub fn from_str(raw: &str) -> Result<&Self, <Timestamp as Validator>::Error>

Transparently reinterprets the string slice as a strongly-typed TimestampRef if it conforms to Timestamp

pub unsafe fn from_str_unchecked(raw: &str) -> &Self

Transparently reinterprets the string slice as a strongly-typed TimestampRef without validating

pub fn into_owned(self: Box<TimestampRef>) -> Timestamp

Converts a Box<TimestampRef> into a Timestamp without copying or allocating

pub const fn as_str(&self) -> &str

Provides access to the underlying value as a string slice.

impl TimestampRef

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

Normalize the timestamp into UTC time.

Examples

use twitch_api2::types::Timestamp;

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

pub fn is_before<T>(&self, other: &T) -> bool where
    Self: PartialOrd<T>, 

Compare another time and return self < other.

Examples

use twitch_api2::types::Timestamp;

let time2021 = Timestamp::new("2021-07-01T13:37:00Z").unwrap();
let time2020 = Timestamp::new("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_api2::types::Timestamp;

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

impl TimestampRef

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 TimestampRef

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 TimestampRef

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Debug for TimestampRef

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for &'a TimestampRef

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

Deserialize this value from the given Serde deserializer.

impl Display for TimestampRef

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

Formats the value using the given formatter.

impl From<&'_ TimestampRef> for Timestamp

fn from(s: &TimestampRef) -> Self

Converts to this type from the input type.

impl<'a, 'b: 'a> From<&'a Cow<'b, TimestampRef>> for &'a TimestampRef

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

Converts to this type from the input type.

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

fn from(r: &'a TimestampRef) -> Self

Converts to this type from the input type.

impl Hash for TimestampRef

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<&'_ TimestampRef> for Timestamp

fn eq(&self, other: &&TimestampRef) -> 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 !=.

impl PartialEq<&'_ TimestampRef> for TimestampRef

fn eq(&self, other: &&TimestampRef) -> 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 !=.

impl PartialEq<&'_ TimestampRef> for Box<TimestampRef>

fn eq(&self, other: &&TimestampRef) -> 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 !=.

impl PartialEq<Box<TimestampRef, Global>> for &TimestampRef

fn eq(&self, other: &Box<TimestampRef>) -> 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 !=.

impl PartialEq<Box<TimestampRef, Global>> for TimestampRef

fn eq(&self, other: &Box<TimestampRef>) -> 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 !=.

impl PartialEq<OffsetDateTime> for TimestampRef

Available on crate feature time only.

fn eq(&self, other: &OffsetDateTime) -> 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 !=.

impl PartialEq<Timestamp> for TimestampRef

fn eq(&self, other: &Timestamp) -> 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 !=.

impl PartialEq<Timestamp> for &TimestampRef

fn eq(&self, other: &Timestamp) -> 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 !=.

impl PartialEq<TimestampRef> for TimestampRef

fn eq(&self, other: &TimestampRef) -> 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 !=.

impl PartialEq<TimestampRef> for Timestamp

fn eq(&self, other: &TimestampRef) -> 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 !=.

impl PartialEq<TimestampRef> for &TimestampRef

fn eq(&self, other: &TimestampRef) -> 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 !=.

impl PartialOrd<OffsetDateTime> for TimestampRef

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

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 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

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 PartialOrd<TimestampRef> for TimestampRef

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

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

Serialize this value into the given Serde serializer.

impl ToOwned for TimestampRef

type Owned = Timestamp

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning.

impl<'a> TryFrom<&'a str> for &'a TimestampRef

type Error = <Timestamp as Validator>::Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for TimestampRef