Skip to content

feat(mention)!: rename timestamp styles and add new styles #2520

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lukadev-0 wants to merge 1 commit into
base: next
Choose a base branch
from
Open

feat(mention)!: rename timestamp styles and add new styles #2520

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 68 additions & 38 deletions twilight-mention/src/timestamp.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ pub enum TimestampStyleConversionErrorType {
pub struct Timestamp {
/// Display modifier style.
///
/// When a style is not specified then [`TimestampStyle::ShortDateTime`] is
/// When a style is not specified then [`TimestampStyle::LongDateShortTime`] is
/// the default; however, we do not implement `Default` for
/// [`TimestampStyle`] because this is a third party implementation detail.
style: Option<TimestampStyle>,
Expand Down Expand Up @@ -140,8 +140,8 @@ impl Timestamp {
/// 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());
/// let timestamp = Timestamp::new(1_624_044_388, Some(TimestampStyle::LongDateShortTime));
/// assert_eq!(Some(TimestampStyle::LongDateShortTime), timestamp.style());
/// ```
#[must_use = "retrieving the style does nothing on its own"]
pub const fn style(&self) -> Option<TimestampStyle> {
Expand Down Expand Up @@ -169,54 +169,67 @@ impl PartialOrd for Timestamp {

/// Style modifier denoting how to display a timestamp.
///
/// The default variant is [`ShortDateTime`].
/// The default variant is [`LongDateShortTime`].
///
/// [`ShortDateTime`]: Self::ShortDateTime
/// [`LongDateShortTime`]: Self::LongDateShortTime
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
#[non_exhaustive]
pub enum TimestampStyle {
/// Style modifier to display a timestamp as a long date/time.
/// Style modifier to display a timestamp as a full date with a short time.
///
/// Correlates to the style `F`.
///
/// Causes mentions to display in clients as `Tuesday, 1 April 2021 01:20`.
LongDateTime,
/// Causes mentions to display in clients as `Tuesday, April 20, 2021 at 16:20`.
FullDateShortTime,
/// Style modifier to display a timestamp as a long date.
///
/// Correlates to the style `D`.
///
/// Causes mentions to display in clients as `1 April 2021`.
/// Causes mentions to display in clients as `April 20, 2021`.
LongDate,
/// Style modifier to display a timestamp as a long date/time.
/// Style modifier to display a timestamp as a long date with a short time.
///
/// Correlates to the style `f`.
///
/// Causes mentions to display in clients as `April 20, 2021 at 16:20`.
///
/// This is the default style when left unspecified.
LongDateShortTime,
/// Style modifier to display a timestamp as a medium time.
///
/// Correlates to the style `T`.
///
/// Causes mentions to display in clients as `01:20:30`.
LongTime,
/// Causes mentions to display in clients as `16:20:30`.
MediumTime,
/// Style modifier to display a timestamp as a relative timestamp.
///
/// Correlates to the style `R`.
///
/// Causes mentions to display in clients as `2 months ago`.
/// Causes mentions to display in clients as `4 years ago`.
RelativeTime,
/// Style modifier to display a timestamp as a short date/time.
/// Style modifier to display a timestamp as a short date.
///
/// Correlates to the style `f`.
/// Correlates to the style `d`.
///
/// Causes mentions to display in clients as `1 April 2021 01:20`.
/// Causes mentions to display in clients as `20/04/2021`.
ShortDate,
/// Style modifier to display a timestamp as a short date with a medium time.
///
/// This is the default style when left unspecified.
ShortDateTime,
/// Style modifier to display a timestamp as a short date/time.
/// Correlates to the style `S`.
///
/// Correlates to the style `d`.
/// Causes mentions to display in clients as `20/04/2021, 16:20:30`.
ShortDateMediumTime,
/// Style modifier to display a timestamp as a short date and time.
///
/// Causes mentions to display in clients as `1/4/2021`.
ShortDate,
/// Style modifier to display a timestamp as a short date/time.
/// Correlates to the style `s`.
///
/// Causes mentions to display in clients as `20/04/2021, 16:20`.
ShortDateShortTime,
/// Style modifier to display a timestamp as a short time.
///
/// Correlates to the style `t`.
///
/// Causes mentions to display in clients as `01:20`.
/// Causes mentions to display in clients as `16:20`.
ShortTime,
}

Expand All @@ -228,18 +241,20 @@ impl TimestampStyle {
/// ```
/// use twilight_mention::timestamp::TimestampStyle;
///
/// assert_eq!("F", TimestampStyle::LongDateTime.style());
/// assert_eq!("F", TimestampStyle::FullDateShortTime.style());
/// assert_eq!("R", TimestampStyle::RelativeTime.style());
/// ```
#[must_use = "retrieving the character of a style does nothing on its own"]
pub const fn style(self) -> &'static str {
match self {
Self::LongDateTime => "F",
Self::FullDateShortTime => "F",
Self::LongDate => "D",
Self::LongTime => "T",
Self::LongDateShortTime => "f",
Self::MediumTime => "T",
Self::RelativeTime => "R",
Self::ShortDateTime => "f",
Self::ShortDate => "d",
Self::ShortDateMediumTime => "S",
Self::ShortDateShortTime => "s",
Self::ShortTime => "t",
}
}
Expand All @@ -257,12 +272,14 @@ impl TryFrom<&str> for TimestampStyle {

fn try_from(value: &str) -> Result<Self, Self::Error> {
Ok(match value {
"F" => Self::LongDateTime,
"F" => Self::FullDateShortTime,
"D" => Self::LongDate,
"T" => Self::LongTime,
"f" => Self::LongDateShortTime,
"T" => Self::MediumTime,
"R" => Self::RelativeTime,
"f" => Self::ShortDateTime,
"d" => Self::ShortDate,
"S" => Self::ShortDateMediumTime,
"s" => Self::ShortDateShortTime,
"t" => Self::ShortTime,
_ => {
return Err(TimestampStyleConversionError {
Expand Down Expand Up @@ -312,27 +329,40 @@ mod tests {
/// Test the corresponding style modifiers.
#[test]
fn timestamp_style_modifiers() {
assert_eq!("F", TimestampStyle::LongDateTime.style());
assert_eq!("F", TimestampStyle::FullDateShortTime.style());
assert_eq!("D", TimestampStyle::LongDate.style());
assert_eq!("T", TimestampStyle::LongTime.style());
assert_eq!("f", TimestampStyle::LongDateShortTime.style());
assert_eq!("T", TimestampStyle::MediumTime.style());
assert_eq!("R", TimestampStyle::RelativeTime.style());
assert_eq!("f", TimestampStyle::ShortDateTime.style());
assert_eq!("d", TimestampStyle::ShortDate.style());
assert_eq!("S", TimestampStyle::ShortDateMediumTime.style());
assert_eq!("s", TimestampStyle::ShortDateShortTime.style());
assert_eq!("t", TimestampStyle::ShortTime.style());
}

/// Test that style modifiers correctly parse from their string slice variants.
#[test]
fn timestamp_style_try_from() -> Result<(), TimestampStyleConversionError> {
assert_eq!(TimestampStyle::try_from("F")?, TimestampStyle::LongDateTime);
assert_eq!(
TimestampStyle::try_from("F")?,
TimestampStyle::FullDateShortTime
);
assert_eq!(TimestampStyle::try_from("D")?, TimestampStyle::LongDate);
assert_eq!(TimestampStyle::try_from("T")?, TimestampStyle::LongTime);
assert_eq!(TimestampStyle::try_from("R")?, TimestampStyle::RelativeTime);
assert_eq!(
TimestampStyle::try_from("f")?,
TimestampStyle::ShortDateTime
TimestampStyle::LongDateShortTime
);
assert_eq!(TimestampStyle::try_from("T")?, TimestampStyle::MediumTime);
assert_eq!(TimestampStyle::try_from("R")?, TimestampStyle::RelativeTime);
assert_eq!(TimestampStyle::try_from("d")?, TimestampStyle::ShortDate);
assert_eq!(
TimestampStyle::try_from("S")?,
TimestampStyle::ShortDateMediumTime
);
assert_eq!(
TimestampStyle::try_from("s")?,
TimestampStyle::ShortDateShortTime
);
assert_eq!(TimestampStyle::try_from("t")?, TimestampStyle::ShortTime);

Ok(())
Expand Down
Loading