Struct Date 

pub struct Date { /* private fields */ }

Date in the proleptic Gregorian calendar.

See the DateUtilities implementation for get, set and manipulation methods.

Range: 30. June -5879611..=12. July 5879611. Please note that year 0 does not exist. After year -1 follows year 1.

Implementations

impl Date

pub fn now() -> Self

Creates a new Date instance with SystemTime::now().

let date = Date::now();
assert!(2021 < date.year());

pub fn from_ymd(year: i32, month: u32, day: u32) -> Result<Self, AstrolabeError>

Creates a new Date instance from year, month and day (day of month).

Returns an OutOfRange error if the provided values are invalid.

let date = Date::from_ymd(2022, 05, 02).unwrap();
assert_eq!("2022/05/02", date.format("yyyy/MM/dd"));

pub fn as_ymd(&self) -> (i32, u32, u32)

Returns the date.

let date = Date::from_ymd(2022, 05, 02).unwrap();
let (year, month, day) = date.as_ymd();
assert_eq!(2022, year);
assert_eq!(5, month);
assert_eq!(2, day);

pub fn parse(string: &str, format: &str) -> Result<Self, AstrolabeError>

Parses a string with a given format and creates a new Date instance from it. See Date::format for a list of available symbols.

Returns an InvalidFormat error if the given string could not be parsed with the given format.

let date = Date::parse("2022-05-02", "yyyy-MM-dd").unwrap();
assert_eq!("2022/05/02", date.format("yyyy/MM/dd"));

pub fn format(&self, format: &str) -> String

Formatting with format strings based on Unicode Date Field Symbols.

Please note that not all symbols are implemented. If you need something that is not implemented, please open an issue on GitHub describing your need.

Available Symbols:

Field Type	Pattern	Examples	Hint
era	G..GGG	AD
	GGGG	Anno Domini	*
	GGGGG	A
year	y	2, 20, 201, 2017, 20173
	yy	02, 20, 01, 17, 73
	yyy	002, 020, 201, 2017, 20173
	yyyy	0002, 0020, 0201, 2017, 20173
	yyyyy+	…	Unlimited length, padded with zeros.
quarter	q	2	*
	qq	02
	qqq	Q2
	qqqq	2nd quarter
	qqqqq	2
month	M	9, 12
	MM	09, 12
	MMM	Sep
	MMMM	September	*
	MMMMM	S
week	w	8, 27	Week of year
	ww	08, 27	*
days	d	1	Day of month
	dd	01	*
	D	1, 24, 135	Day of year, *
	DD	01, 24, 135
	DDD	001, 024, 135
week day	e	3	1-7, 1 is Sunday, *
	ee	03	1-7, 1 is Sunday
	eee	Tue
	eeee	Tuesday
	eeeee	T
	eeeeee	Tu
	eeeeeee	2	1-7, 1 is Monday
	eeeeeeee	02	1-7, 1 is Monday

* = Default

If the sequence is longer than listed in the table, the output will be the same as the default pattern for this unit (marked with *).

Surround any character with apostrophes (') to escape them. If you want escape ', write ''.

let date = Date::from_ymd(2022, 5, 2).unwrap();
assert_eq!("2022/05/02", date.format("yyyy/MM/dd"));
// Escape characters
assert_eq!("2022/MM/dd", date.format("yyyy/'MM/dd'"));
assert_eq!("2022/'05/02'", date.format("yyyy/''MM/dd''"));

pub fn duration_between(&self, compare: &Self) -> Duration

Returns the duration between the provided date.

Trait Implementations

impl Add<Duration> for Date

fn add(self, rhs: Duration) -> Self::Output

Performs the + operation.

Only adds full days (86 400 seconds) to Date. Any additional duration will be ignored.

type Output = Date

The resulting type after applying the + operator.

impl AddAssign<Duration> for Date

fn add_assign(&mut self, rhs: Duration)

Performs the += operation.

Only adds full days (86 400 seconds) to Date. Any additional duration will be ignored.

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 DateUtilities for Date

fn year(&self) -> i32

Returns the year.

fn month(&self) -> u32

Returns the month of the year (1-12).

fn day(&self) -> u32

Returns the day of the month (1-31).

fn day_of_year(&self) -> u32

Returns the day of the year (1-365 or 1-366).

fn weekday(&self) -> u8

Returns the day of the week (0-6, 0 is Sunday).

fn from_timestamp(timestamp: i64) -> Self

Creates a date from a unix timestamp (non-leap seconds since January 1, 1970 00:00:00 UTC).

fn timestamp(&self) -> i64

Returns the number of non-leap seconds since January 1, 1970 00:00:00 UTC. (Negative if date is before)

fn set_year(&self, year: i32) -> Result<Self, AstrolabeError>

Sets the year to the provided value. Has to be in range -5879611..=5879611.

fn set_month(&self, month: u32) -> Result<Self, AstrolabeError>

Sets the month of the year to the provided value. Has to be in range 1..=12.

fn set_day(&self, day: u32) -> Result<Self, AstrolabeError>

Sets the day of the month to the provided value. Has to be in range 1..=31 and cannot be greater than the number of days in the current month.

fn set_day_of_year(&self, day_of_year: u32) -> Result<Self, AstrolabeError>

Sets the day of the year to the provided value. Has to be in range 1..=365 or 1..=366 in case of a leap year.

fn add_years(&self, years: u32) -> Self

Adds the provided years to the current date.

fn add_months(&self, months: u32) -> Self

Adds the provided months to the current date.

fn add_days(&self, days: u32) -> Self

Adds the provided days to the current date.

fn sub_years(&self, years: u32) -> Self

Subtracts the provided years from the current date.

fn sub_months(&self, months: u32) -> Self

Subtracts the provided months from the current date.

fn sub_days(&self, days: u32) -> Self

Subtracts the provided days from the current date.

fn clear_until_year(&self) -> Self

Clears date/time units until the year (inclusive).

fn clear_until_month(&self) -> Self

Clears date/time units until the month (inclusive).

fn clear_until_day(&self) -> Self

Clears date/time units until the day (inclusive).

fn years_since(&self, compare: &Self) -> i32

Returns full years since the provided date.

fn months_since(&self, compare: &Self) -> i32

Returns full months since the provided date.

fn days_since(&self, compare: &Self) -> i64

Returns full days since the provided date.

impl Debug for Date

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

Formats the value using the given formatter.

impl Decode<'_, Postgres> for Date

Available on crate features sqlx-postgres and sqlx only.

fn decode(value: PgValueRef<'_>) -> Result<Self, BoxDynError>

Decode a new value of this type using a raw value from the database.

impl Default for Date

fn default() -> Date

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Date

Available on crate feature serde only.

Deserialize a yyyy-MM-dd formatted string into a Date instance.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Date

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

Formats the value using the given formatter.

impl Encode<'_, Postgres> for Date

Available on crate features sqlx-postgres and sqlx only.

fn encode_by_ref( &self, buf: &mut PgArgumentBuffer, ) -> Result<IsNull, BoxDynError>

Writes the value of self into buf without moving self.

fn size_hint(&self) -> usize

fn encode( self, buf: &mut <DB as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

where Self: Sized,

Writes the value of self into buf in the expected format for the database.

fn produces(&self) -> Option<<DB as Database>::TypeInfo>

impl From<&Date> for Date

fn from(date: &Date) -> Self

Converts to this type from the input type.

impl From<&Date> for DateTime

fn from(value: &Date) -> Self

Converts to this type from the input type.

impl From<&DateTime> for Date

fn from(value: &DateTime) -> Self

Converts to this type from the input type.

impl From<Date> for DateTime

fn from(value: Date) -> Self

Converts to this type from the input type.

impl From<DateTime> for Date

fn from(value: DateTime) -> Self

Converts to this type from the input type.

impl FromStr for Date

type Err = AstrolabeError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

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 PgHasArrayType for Date

Available on crate features sqlx-postgres and sqlx only.

fn array_type_info() -> PgTypeInfo

fn array_compatible(ty: &PgTypeInfo) -> bool

impl Serialize for Date

Available on crate feature serde only.

Serialize a Date instance as yyyy-MM-dd.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<Duration> for Date

fn sub(self, rhs: Duration) -> Self::Output

Performs the - operation.

Only removes full days (86 400 seconds) to Date. Any additional duration will be ignored.

type Output = Date

The resulting type after applying the - operator.

impl SubAssign<Duration> for Date

fn sub_assign(&mut self, rhs: Duration)

Performs the -= operation.

Only removes full days (86 400 seconds) to Date. Any additional duration will be ignored.

impl Type<Postgres> for Date

Available on crate features sqlx-postgres and sqlx only.

fn type_info() -> PgTypeInfo

Returns the canonical SQL type for this Rust type.

fn compatible(ty: &<DB as Database>::TypeInfo) -> bool

Determines if this Rust type is compatible with the given SQL type.

impl Copy for Date

impl Eq for Date

impl StructuralPartialEq for Date