Struct utc2k::FmtUtc2k

pub struct FmtUtc2k(_);

Formatted UTC2K.

This is the formatted companion to Utc2k. 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 Deref, AsRef<str>, Borrow<str>, or FmtUtc2k::as_str.

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

Examples

Generally it makes more sense to initialize a Utc2k first, but you can skip straight to a FmtUtc2k instead:

use utc2k::{FmtUtc2k, Utc2k};

// Start with the current date/time.
let date = FmtUtc2k::now();

// Source from a specific timestamp.
let date = FmtUtc2k::from(946_684_800_u32);
assert_eq!(date.as_str(), "2000-01-01 00:00:00");

// Source from a `Utc2k`.
let utc_date = Utc2k::from(946_684_800_u32);
assert_eq!(FmtUtc2k::from(utc_date), utc_date.formatted());

Implementations

impl FmtUtc2k

Min/Max.

pub const fn min() -> Self

Minimum Value.

This is equivalent to 2000-01-01 00:00:00.

Examples

use utc2k::FmtUtc2k;

let date = FmtUtc2k::min();
assert_eq!(date.as_str(), "2000-01-01 00:00:00");

pub const fn max() -> Self

Maximum Value.

This is equivalent to 2099-12-31 23:59:59.

Examples

use utc2k::FmtUtc2k;

let date = FmtUtc2k::max();
assert_eq!(date.as_str(), "2099-12-31 23:59:59");

impl FmtUtc2k

Instantiation/Reuse.

pub fn now() -> Self

Now.

This returns an instance using the current unixtime as the seed.

pub fn set_datetime(&mut self, src: Utc2k)

Set Date/Time.

This can be used to recycle an existing buffer.

As with all other part-based operations, overflows and underflows will be adjusted automatically, with minimum and maximum dates capped to FmtUtc2k::min and FmtUtc2k::max respectively.

Examples

use utc2k::{FmtUtc2k, Utc2k};

let mut fmt = FmtUtc2k::default();
assert_eq!(fmt.as_str(), "2000-01-01 00:00:00");

fmt.set_datetime(Utc2k::from(Utc2k::MAX_UNIXTIME));
assert_eq!(fmt.as_str(), "2099-12-31 23:59:59");

pub fn set_parts(&mut self, y: u16, m: u8, d: u8, hh: u8, mm: u8, ss: u8)

Set Parts.

This can be used to recycle an existing buffer.

As with all other part-based operations, overflows and underflows will be adjusted automatically, with minimum and maximum dates capped to FmtUtc2k::min and FmtUtc2k::max respectively.

Examples

use utc2k::{FmtUtc2k, Utc2k};

let mut fmt = FmtUtc2k::default();
assert_eq!(fmt.as_str(), "2000-01-01 00:00:00");

fmt.set_parts(2010, 10, 31, 12, 33, 59);
assert_eq!(fmt.as_str(), "2010-10-31 12:33:59");

// And if you do something weird with the dates...
fmt.set_parts(2010, 10, 32, 12, 33, 59);
assert_eq!(fmt.as_str(), "2010-11-01 12:33:59");

pub fn set_unixtime(&mut self, src: u32)

Set Unixtime.

This can be used to recycle an existing buffer.

As with all other part-based operations, overflows and underflows will be adjusted automatically, with minimum and maximum dates capped to Utc2k::MIN_UNIXTIME and Utc2k::MAX_UNIXTIME respectively.

Examples

use utc2k::{FmtUtc2k, Utc2k};

let mut fmt = FmtUtc2k::from(Utc2k::MIN_UNIXTIME);
assert_eq!(fmt.as_str(), "2000-01-01 00:00:00");

fmt.set_unixtime(Utc2k::MAX_UNIXTIME);
assert_eq!(fmt.as_str(), "2099-12-31 23:59:59");

impl FmtUtc2k

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 FmtUtc2k::as_ref.

Examples

use utc2k::FmtUtc2k;

let fmt = FmtUtc2k::max();
assert_eq!(fmt.as_bytes(), b"2099-12-31 23:59:59");

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

As Str.

Return a string slice in YYYY-MM-DD HH:MM:SS format.

A string slice can also be obtained using FmtUtc2k::as_ref or through dereferencing.

Examples

use utc2k::FmtUtc2k;

let fmt = FmtUtc2k::max();
assert_eq!(fmt.as_str(), "2099-12-31 23:59:59");

pub fn date(&self) -> &str

Just the Date Bits.

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

Examples

use utc2k::{FmtUtc2k, Utc2k};

let fmt = FmtUtc2k::from(Utc2k::MAX_UNIXTIME);
assert_eq!(fmt.as_str(), "2099-12-31 23:59:59");
assert_eq!(fmt.date(), "2099-12-31");

pub fn time(&self) -> &str

Just the Time Bits.

This returns the time as a string slice in HH:MM:SS format.

Examples

use utc2k::{FmtUtc2k, Utc2k};

let fmt = FmtUtc2k::from(Utc2k::MAX_UNIXTIME);
assert_eq!(fmt.as_str(), "2099-12-31 23:59:59");
assert_eq!(fmt.time(), "23:59:59");

Trait Implementations

impl AsRef<[u8]> for FmtUtc2k

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

Performs the conversion.

impl AsRef<str> for FmtUtc2k

fn as_ref(&self) -> &str

Performs the conversion.

impl Borrow<str> for FmtUtc2k

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for FmtUtc2k

fn clone(&self) -> FmtUtc2k

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FmtUtc2k

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

Formats the value using the given formatter.

impl Default for FmtUtc2k

fn default() -> Self

Returns the “default value” for a type.

impl Deref for FmtUtc2k

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for FmtUtc2k

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

Formats the value using the given formatter.

impl From<Utc2k> for FmtUtc2k

fn from(src: Utc2k) -> Self

Performs the conversion.

impl From<u32> for FmtUtc2k

fn from(src: u32) -> Self

Performs the conversion.

impl Hash for FmtUtc2k

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

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<FmtUtc2k> for FmtUtc2k

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

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

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

This method tests for !=.

impl PartialOrd<FmtUtc2k> for FmtUtc2k

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 TryFrom<&'_ OsStr> for FmtUtc2k

fn try_from(src: &OsStr) -> Result<Self, Self::Error>

From OsStr.

use std::ffi::OsStr;
use utc2k::FmtUtc2k;

assert_eq!(
    FmtUtc2k::try_from(OsStr::new("2013-12-15 21:30:02")).unwrap().as_str(),
    "2013-12-15 21:30:02"
);
assert_eq!(
    FmtUtc2k::try_from(OsStr::new("2013-12-15")).unwrap().as_str(),
    "2013-12-15 00:00:00"
);

type Error = Utc2kError

The type returned in the event of a conversion error.

impl TryFrom<&'_ str> for FmtUtc2k

type Error = Utc2kError

The type returned in the event of a conversion error.

fn try_from(src: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i32> for FmtUtc2k

type Error = Utc2kError

The type returned in the event of a conversion error.

fn try_from(src: i32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i64> for FmtUtc2k

type Error = Utc2kError

The type returned in the event of a conversion error.

fn try_from(src: i64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<isize> for FmtUtc2k

type Error = Utc2kError

The type returned in the event of a conversion error.

fn try_from(src: isize) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u64> for FmtUtc2k

type Error = Utc2kError

The type returned in the event of a conversion error.

fn try_from(src: u64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<usize> for FmtUtc2k

type Error = Utc2kError

The type returned in the event of a conversion error.

fn try_from(src: usize) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for FmtUtc2k

impl Eq for FmtUtc2k

impl StructuralEq for FmtUtc2k

impl StructuralPartialEq for FmtUtc2k