Struct twilight_mention::timestamp::Timestamp

pub struct Timestamp { /* private fields */ }

Timestamp representing a time to be formatted based on a client’s current local timezone and locale.

Timestamps can be compared based on their unix value.

Examples

Compare two timestamps to determine which is more recent:

use twilight_mention::timestamp::Timestamp;

let old = Timestamp::new(1_500_000_000, None);
let new = Timestamp::new(1_600_000_000, None);

assert!(new > old);

Implementations

impl Timestamp

pub const fn new(unix: u64, style: Option<TimestampStyle>) -> Self

Create a new timestamp with a Unix timestamp and optionally a style.

The Unix timestamp is in seconds.

Examples

Create a timestamp without a display modifier and format it as a mention:

use twilight_mention::{timestamp::Timestamp, Mention};

let timestamp = Timestamp::new(1624044388, None);
assert_eq!("<t:1624044388>", timestamp.mention().to_string());

pub const fn style(&self) -> Option<TimestampStyle>

Style representing the display modifier.

use twilight_mention::timestamp::{Timestamp, TimestampStyle};

// When leaving a style unspecified a default is not provided.
assert!(Timestamp::new(1624044388, None).style().is_none());

// The same style is returned when a style is specified.
let timestamp = Timestamp::new(1_624_044_388, Some(TimestampStyle::ShortDateTime));
assert_eq!(Some(TimestampStyle::ShortDateTime), timestamp.style());

pub const fn unix(&self) -> u64

Unix timestamp.

Trait Implementations

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

Mention a timestamp. This will format as <t:UNIX> if a style is not specified or <t:UNIX:STYLE> if a style is specified.

fn mention(&self) -> MentionFormat<Self>

Mention a resource by using its ID.

impl Ord for Timestamp

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

Restrict a value to a certain interval.

impl ParseMention for Timestamp

fn parse(buf: &str) -> Result<Self, ParseMentionError<'_>>

where Self: Sized,

Parse a timestamp from a string slice.

Examples

Returns ParseMentionErrorType::TimestampStyleInvalid if the timestamp style value is invalid.

const SIGILS: &'static [&'static str] = _

Leading sigil(s) of the mention after the leading arrow (<).

fn iter(buf: &str) -> MentionIter<'_, Self>

where Self: Sized,

Search a buffer for mentions and parse out any that are encountered.

impl PartialEq for Timestamp

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Timestamp

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

impl Eq for Timestamp

impl StructuralPartialEq for Timestamp