Struct Date

pub struct Date { /* private fields */ }

Representation for LocalMktDate and and UTCDateOnly in YYYYMMDD format.

Examples

• 19411208
• 16201211
• 18630101
• 20170526

Implementations

impl Date

pub fn new(year: u32, month: u32, day: u32) -> Option<Self>

Creates a new date from its components. It returns None if any of the three components is outside the legal range.

Examples

use hotfix_encoding::field_types::Date;

assert!(Date::new(2021, 4, 16).is_some());
assert!(Date::new(2021, 13, 32).is_none());

// Support from January 1, year zero (which doesn't actually exist) to
// December 31, 9999.
assert!(Date::new(0, 1, 1).is_some());
assert!(Date::new(9999, 12, 31).is_some());

// We don't check month-aware day boundaries, i.e. go ahead and assume
// every month has 31 days.
assert!(Date::new(2021, 2, 31).is_some());

pub fn to_yyyymmdd(&self) -> [u8; 8]

Converts self to YYYYMMDD format.

Examples

use hotfix_encoding::field_types::Date;

assert_eq!(&Date::new(2021, 01, 01).unwrap().to_yyyymmdd(), b"20210101");

pub fn year(&self) -> u32

Returns the year of self.

pub fn month(&self) -> u32

Returns the month of self (1-indexing, i.e. 1-12).

pub fn day(&self) -> u32

Returns the day of self (1-indexing, i.e. 1-31).

Trait Implementations

impl Clone for Date

fn clone(&self) -> Date

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Date

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

Formats the value using the given formatter.

impl<'a> FieldType<'a> for Date

type Error = &'static str

The error type that can arise during deserialization.

type SerializeSettings = ()

A type with values that customize the serialization algorithm, e.g. padding information.

fn serialize_with<B>(&self, buffer: &mut B, _settings: ()) -> usize

where B: Buffer,

Writes self to buffer using custom serialization settings.

fn deserialize(data: &'a [u8]) -> Result<Self, Self::Error>

Parses and deserializes from data.

fn deserialize_lossy(data: &'a [u8]) -> Result<Self, Self::Error>

Like FieldType::deserialize, but it’s allowed to skip some amount of input checking. Invalid inputs might not trigger errors and instead be deserialized as random values.

fn serialize<B>(&self, buffer: &mut B) -> usize

where B: Buffer,

Writes self to buffer using default settings.

fn to_bytes(&self) -> Vec<u8>

Serializes self to a Vec of bytes, allocated on the fly.

fn to_string(&self) -> String

Allocates a String representation of self, using FieldType::to_bytes.

impl Ord for Date

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

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

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

impl Eq for Date

impl StructuralPartialEq for Date