Struct twitch_api2::types::Timestamp

source · [−]

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

Expand description

RFC3339 timestamp

Implementations

impl Timestamp

pub fn new<S: Into<String> + AsRef<str>>(
s: S
) -> Result<Self, <Timestamp as Validator>::Error>

Constructs a new Timestamp if it conforms to Timestamp

pub unsafe fn new_unchecked<S: Into<String>>(s: S) -> 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 into_boxed_ref(self) -> Box<TimestampRef>

Converts this Timestamp into a Box<TimestampRef>

This will drop any excess capacity.

pub fn into_string(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 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")

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. Read more

impl Borrow<str> for Timestamp

fn borrow(&self) -> &str

Immutably borrows from an owned value. Read more

impl Clone for Timestamp

fn clone(&self) -> Timestamp

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl<'a> Debug for Timestamp

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

Formats the value using the given formatter. Read more

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

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

Deserialize this value from the given Serde deserializer. Read more

impl<'a> Display for Timestamp

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

Formats the value using the given formatter. Read more

impl From<&'_ TimestampRef> for Timestamp

fn from(s: &TimestampRef) -> Self

Converts to this type from the input type.

impl From<Box<TimestampRef, Global>> 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<'a> From<Timestamp> for Cow<'a, TimestampRef>

fn from(owned: Timestamp) -> Self

Converts to this type from the input type.

impl FromStr for Timestamp

type Err = <Timestamp as Validator>::Error

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. Read more

impl Hash for Timestamp

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

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 ==. Read more

1.0.0 · source

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

This method tests for !=.

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

fn eq(&self, other: &Box<TimestampRef>) -> bool

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

1.0.0 · source

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

This method tests for !=.

impl PartialEq<OffsetDateTime> for Timestamp

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 ==. Read more

1.0.0 · source

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

This method tests for !=.

impl PartialEq<Timestamp> for Timestamp

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

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

1.0.0 · source

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 ==. Read more

1.0.0 · source

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 ==. Read more

1.0.0 · source

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

This method tests for !=.

impl PartialEq<Timestamp> for Box<TimestampRef>

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

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

1.0.0 · source

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 ==. Read more

1.0.0 · source

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

This method tests for !=.

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. Read more

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

impl PartialOrd<Timestamp> for Timestamp

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

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. Read more

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

impl Serialize for Timestamp

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

Serialize this value into the given Serde serializer. Read more

impl TryFrom<&'_ str> for Timestamp

type Error = <Timestamp as Validator>::Error

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 = <Timestamp as Validator>::Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Validator for Timestamp

type Error = TimestampParseError

The error produced when the string is invalid

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

Validates a string according to a predetermined set of rules

impl Eq for Timestamp

Auto Trait Implementations

impl RefUnwindSafe for Timestamp

impl Send for Timestamp

impl Sync for Timestamp

impl Unpin for Timestamp

impl UnwindSafe for Timestamp

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

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

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

impl<T> ToString for T where
T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,