Struct FmtLocal2k 

pub struct FmtLocal2k { /* private fields */ }

Available on crate feature local only.

Formatted Local UTC2K.

This is the formatted companion to Local2k. You can use it to obtain a string version of the date, print it, etc.

While this acts essentially as a glorified String, it is sized exactly and therefore requires less memory to represent. It also implements Copy.

It follows the simple Unix date format of YYYY-MM-DD hh:mm:ss.

Speaking of, you can obtain an &str using AsRef<str>, Borrow<str>, or FmtLocal2k::as_str.

If you only want the date or time half, call FmtLocal2k::date or FmtLocal2k::time respectively.

See Local2k for limitations and gotchas.

Implementations

impl FmtLocal2k

Instantiation.

pub fn now() -> Self

Now.

Create a new instance representing the current local time.

use utc2k::{FmtLocal2k, Local2k};

// Equivalent.
assert_eq!(
    FmtLocal2k::now(),
    FmtLocal2k::from(Local2k::now()),
);

impl FmtLocal2k

Getters.

pub const fn as_bytes(&self) -> &[u8]

As Bytes.

Return a byte string slice in YYYY-MM-DD hh:mm:ss format.

A byte slice can also be obtained using FmtLocal2k::as_ref.

Examples

use utc2k::{Local2k, Utc2k};

let fmt = Local2k::from(Utc2k::MAX).formatted();
assert_eq!(
    fmt.as_bytes(),
    b"2099-12-31 15:59:59", // e.g. California.
);

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

As Str.

Return a string slice in YYYY-MM-DD hh:mm:ss format.

Examples

use utc2k::{Local2k, Utc2k};

let fmt = Local2k::from(Utc2k::MAX).formatted();
assert_eq!(
    fmt.as_str(),
    "2099-12-31 15:59:59", // e.g. California.
);

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

Just the Date Bits.

This returns the date as a string slice in YYYY-MM-DD format.

Examples

use utc2k::{Local2k, Utc2k};

let utc = Utc2k::new(2025, 6, 19, 18, 57, 12);
let fmt = Local2k::from(utc).formatted();
assert_eq!(
    fmt.as_str(),
    "2025-06-19 11:57:12", // e.g. California.
);
assert_eq!(fmt.date(), "2025-06-19");

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

Just the Year Bit.

This returns the year as a string slice.

Examples

use utc2k::{Local2k, Utc2k};

let utc = Utc2k::new(2025, 6, 19, 18, 57, 12);
let fmt = Local2k::from(utc).formatted();
assert_eq!(
    fmt.as_str(),
    "2025-06-19 11:57:12", // e.g. California.
);
assert_eq!(fmt.year(), "2025");

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

Just the Time Bits.

This returns the time as a string slice in hh:mm:ss format.

Examples

use utc2k::{Local2k, Utc2k};

let utc = Utc2k::new(2025, 6, 19, 18, 57, 12);
let fmt = Local2k::from(utc).formatted();
assert_eq!(
    fmt.as_str(),
    "2025-06-19 11:57:12", // e.g. California.
);
assert_eq!(fmt.time(), "11:57:12");

impl FmtLocal2k

Conversion.

pub fn to_rfc2822(&self) -> String

To RFC2822.

Return a string formatted according to RFC2822.

Examples

use utc2k::{Local2k, Utc2k};

// A proper UTC date in RFC2822.
let utc = Utc2k::new(2021, 12, 13, 04, 56, 1);
assert_eq!(
    utc.to_rfc2822(),
    "Mon, 13 Dec 2021 04:56:01 +0000",
);

// The same date localized to, say, California.
let local = Local2k::from(utc).formatted();
assert_eq!(
    local.to_rfc2822(),
    "Sun, 12 Dec 2021 20:56:01 -0800",
);

The RFC2822 date/time format is portable, whether local or UTC.

let utc_2822 = utc.to_rfc2822();
let local_2822 = local.to_rfc2822();

// The RFC2822 representations will vary if there's an offset, but
// if parsed back into a Utc2k, that'll get sorted and they'll match!
assert_eq!(
    Utc2k::from_rfc2822(utc_2822.as_bytes()),
    Some(utc),
);
assert_eq!(
    Utc2k::from_rfc2822(local_2822.as_bytes()),
    Some(utc),
);

pub fn to_rfc3339(&self) -> String

To RFC3339.

Return a string formatted according to RFC3339.

Examples

use utc2k::{Local2k, Utc2k};

// A proper UTC date in RFC3339.
let utc = Utc2k::new(2021, 12, 13, 11, 56, 1);
assert_eq!(utc.to_rfc3339(), "2021-12-13T11:56:01Z");

// The same date localized to, say, California.
let local = Local2k::from(utc).formatted();
assert_eq!(local.to_rfc3339(), "2021-12-13T03:56:01-0800");

The RFC3339 date/time format is portable, whether local or UTC.

let utc_3339 = utc.to_rfc3339();
let local_3339 = local.to_rfc3339();

// The RFC3339 representations will vary if there's an offset, but
// if parsed back into a Utc2k, that'll get sorted and they'll match!
assert_eq!(
    Utc2k::from_ascii(utc_3339.as_bytes()),
    Some(utc),
);
assert_eq!(
    Utc2k::from_ascii(local_3339.as_bytes()),
    Some(utc),
);

Trait Implementations

impl AsRef<[u8]> for FmtLocal2k

fn as_ref(&self) -> &[u8]

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

impl AsRef<str> for FmtLocal2k

fn as_ref(&self) -> &str

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

impl Borrow<str> for FmtLocal2k

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for FmtLocal2k

fn clone(&self) -> FmtLocal2k

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FmtLocal2k

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

Formats the value using the given formatter.

impl Display for FmtLocal2k

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

Formats the value using the given formatter.

impl From<&FmtLocal2k> for Local2k

fn from(src: &FmtLocal2k) -> Self

Converts to this type from the input type.

impl From<FmtLocal2k> for Local2k

fn from(src: FmtLocal2k) -> Self

Converts to this type from the input type.

impl From<FmtLocal2k> for String

fn from(src: FmtLocal2k) -> Self

Converts to this type from the input type.

impl From<Local2k> for FmtLocal2k

fn from(src: Local2k) -> Self

Converts to this type from the input type.

impl Hash for FmtLocal2k

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 Ord for FmtLocal2k

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

Restrict a value to a certain interval.

impl PartialEq<&Box<str>> for FmtLocal2k

fn eq(&self, other: &&Box<str>) -> 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<&Cow<'_, str>> for FmtLocal2k

fn eq(&self, other: &&Cow<'_, str>) -> 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<&String> for FmtLocal2k

fn eq(&self, other: &&String) -> 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<&str> for FmtLocal2k

fn eq(&self, other: &&str) -> 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<Box<str>> for FmtLocal2k

fn eq(&self, other: &Box<str>) -> 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<Cow<'_, str>> for FmtLocal2k

fn eq(&self, other: &Cow<'_, str>) -> 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<FmtLocal2k> for &Box<str>

fn eq(&self, other: &FmtLocal2k) -> 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<FmtLocal2k> for &Cow<'_, str>

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

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

fn eq(&self, other: &FmtLocal2k) -> 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<FmtLocal2k> for Box<str>

fn eq(&self, other: &FmtLocal2k) -> 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<FmtLocal2k> for Cow<'_, str>

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

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

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

fn eq(&self, other: &String) -> 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<str> for FmtLocal2k

fn eq(&self, other: &str) -> 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 FmtLocal2k

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

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

impl Eq for FmtLocal2k