Struct Date

pub struct Date(/* private fields */);

A safe wrapper around Postgres DATE type, backed by a pg_sys::DateADT integer value.

Implementations

impl Date

pub fn new( year: i32, month: u8, day: u8, ) -> Result<Self, DateTimeConversionError>

Construct a new Date from its constituent parts.

Errors

Returns a DateTimeConversionError if any of the specified parts don’t fit within the bounds of a standard date.

pub fn new_unchecked(year: isize, month: u8, day: u8) -> Self

Construct a new Date from its constituent parts.

This function elides the error trapping overhead in the event of out-of-bounds parts.

Panics

This function will panic, aborting the current transaction, if any part is out-of-bounds.

pub fn saturating_from_raw(date_int: DateADT) -> Date

From Date’s raw encoding type (i32), construct a valid in-range Date by saturating to the nearest infinity if out-of-bounds.

pub fn positive_infinity() -> Self

Construct a new Date representing positive infinity

pub fn negative_infinity() -> Self

Construct a new Date representing negative infinity

pub unsafe fn from_pg_epoch_days(pg_epoch_days: i32) -> Date

Create a new Date from an integer value from Postgres’ epoch, in days.

Safety

This function is unsafe as you must guarantee pg_epoch_days is valid. You’ll always get a fully constructed Date in return, but it may not be something Postgres actually understands.

pub fn month(&self) -> u8

Extract the month

pub fn day(&self) -> u8

Extract the day

pub fn year(&self) -> i32

Extract the year

pub fn is_infinity(&self) -> bool

Does this Date represent positive infinity?

pub fn is_neg_infinity(&self) -> bool

Does this Date represent negative infinity?

pub fn to_julian_days(&self) -> i32

Return the Julian days value of this Date

pub fn to_pg_epoch_days(&self) -> i32

Return the Postgres epoch days value of this Date

pub fn to_unix_epoch_days(&self) -> i32

Returns the date as an i32 representing the elapsed time since UNIX epoch in days

pub fn to_posix_time(&self) -> time_t

Return the date as a stack-allocated libc::time_t instance

pub fn is_finite(&self) -> bool

pub fn into_inner(self) -> DateADT

Return the backing pg_sys::DateADT value.

Trait Implementations

impl Add<Date> for Interval

type Output = Timestamp

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Date> for Time

type Output = Timestamp

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Date> for TimeWithTimeZone

type Output = TimestampWithTimeZone

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Date> for i32

type Output = Date

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Interval> for Date

type Output = Timestamp

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Time> for Date

type Output = Timestamp

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<TimeWithTimeZone> for Date

type Output = TimestampWithTimeZone

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<i32> for Date

type Output = Date

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'fcx> ArgAbi<'fcx> for Date

unsafe fn unbox_arg_unchecked(arg: Arg<'_, 'fcx>) -> Self

Unbox an argument with a matching type.

unsafe fn unbox_nullable_arg(arg: Arg<'_, 'fcx>) -> Nullable<Self>

Unbox a nullable arg

fn is_virtual_arg() -> bool

“Is this a virtual arg?”

impl BorrowDatum for Date

const PASS: PassBy

The “native” passing convention for this type.

unsafe fn point_from(ptr: NonNull<u8>) -> NonNull<Self>

Cast a pointer to this blob of bytes to a pointer to this type.

unsafe fn point_from_align4(ptr: NonNull<u32>) -> NonNull<Self>

Cast a pointer to aligned varlena headers to this type

unsafe fn borrow_unchecked<'dat>(ptr: NonNull<u8>) -> &'dat Self

Optimization for borrowing the referent

impl BoxRet for Date

unsafe fn box_into<'fcx>(self, fcinfo: &mut FcInfo<'fcx>) -> Datum<'fcx>

Safety

impl Clone for Date

fn clone(&self) -> Date

Returns a copy 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<'de> Deserialize<'de> for Date

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

Uses the underlying “output” function to convert this type to a String

impl From<Date> for Timestamp

fn from(value: Date) -> Self

Converts to this type from the input type.

impl From<Date> for TimestampWithTimeZone

fn from(value: Date) -> Self

Converts to this type from the input type.

impl From<Date> for DateADT

fn from(value: Date) -> Self

Converts to this type from the input type.

impl From<Timestamp> for Date

fn from(value: Timestamp) -> Self

Converts to this type from the input type.

impl From<TimestampWithTimeZone> for Date

fn from(value: TimestampWithTimeZone) -> Self

Converts to this type from the input type.

impl FromDatum for Date

unsafe fn from_polymorphic_datum( datum: Datum, is_null: bool, _: Oid, ) -> Option<Self>

where Self: Sized,

Like from_datum for instantiating polymorphic types which require preserving the dynamic type metadata.

const GET_TYPOID: bool = false

Should a type OID be fetched when calling from_datum?

unsafe fn from_datum(datum: Datum, is_null: bool) -> Option<Self>

Safety

unsafe fn from_datum_in_memory_context( memory_context: PgMemoryContexts, datum: Datum, is_null: bool, typoid: Oid, ) -> Option<Self>

Default implementation switched to the specified memory context and then simply calls FromDatum::from_datum(...) from within that context.

unsafe fn try_from_datum( datum: Datum, is_null: bool, type_oid: Oid, ) -> Result<Option<Self>, TryFromDatumError>

where Self: IntoDatum,

try_from_datum is a convenience wrapper around FromDatum::from_datum that returns a a Result around an Option, as a Datum can be null. It’s intended to be used in situations where the caller needs to know whether the type conversion succeeded or failed.

unsafe fn try_from_datum_in_memory_context( memory_context: PgMemoryContexts, datum: Datum, is_null: bool, type_oid: Oid, ) -> Result<Option<Self>, TryFromDatumError>

where Self: IntoDatum,

A version of try_from_datum that switches to the given context to convert from Datum

impl FromStr for Date

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

Create this type from a string.

type Err = DateTimeConversionError

The associated error which can be returned from parsing.

impl HasExtractableParts for Date

const EXTRACT_FUNCTION: unsafe fn(FunctionCallInfo) -> Datum = {pgrx_pg_sys::extract_date as unsafe fn(*mut pgrx_pg_sys::FunctionCallInfoBaseData) -> pgrx_pg_sys::Datum}

fn extract_part(&self, field: DateTimeParts) -> Option<AnyNumeric>

Extract a DateTimeParts part from a date/time-like type

impl Hash for Date

fn hash<H: Hasher>(&self, state: &mut H)

Uses the underlying Postgres “hash” function for this type

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

fn into_datum(self) -> Option<Datum>

fn type_oid() -> Oid

fn composite_type_oid(&self) -> Option<Oid>

fn is_compatible_with(other: Oid) -> bool

Is a Datum of this type compatible with another Postgres type?

impl Ord for Date

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

Uses the underlying Postgres “_cmp()” function for this type

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: &Self) -> bool

Uses the underlying Postgres “_eq()” function for this type

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: &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 RangeSubType for Date

for date/daterange

fn range_type_oid() -> Oid

impl Serialize for Date

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

where S: Serializer,

Serialize this Date in ISO form, compatible with most JSON parsers

impl SqlTranslatable for Date

fn argument_sql() -> Result<SqlMapping, ArgumentError>

fn return_sql() -> Result<Returns, ReturnsError>

fn type_name() -> &'static str

fn variadic() -> bool

fn optional() -> bool

fn entity() -> FunctionMetadataTypeEntity

impl Sub<Interval> for Date

type Output = Timestamp

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<i32> for Date

type Output = Date

The resulting type after applying the - operator.

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

Performs the - operation.

impl ToIsoString for Date

fn to_iso_string(self) -> String

Encode of this date/time-like type into JSON string in ISO format using optionally preallocated buffer ‘buf’.

fn to_iso_string_with_timezone<Tz: AsRef<str>>( self, timezone: Tz, ) -> Result<String, DateTimeConversionError>

Encode of this date/time-like type into JSON string in ISO format using optionally preallocated buffer ‘buf’.

impl TryFrom<Datum> for Date

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(datum: Datum) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i32> for Date

Create a Date from a pg_sys::DateADT

Note that pg_sys::DateADT is an i32 as a Julian day offset from the “Postgres epoch”.

The details of the encoding may also prove surprising, for instance:

• It is not a Gregorian calendar date, but rather a Julian day
• Despite having the numerical range for it, it does not support values before Julian day 0 (4713 BC, January 1), nor does it support many values far into the future.
• There is no “year zero” in either the Julian or the Gregorian calendars, so you may have to account for a “skip” from 1 BC to 1 AD
• Some values such as i32::MIN and i32::MAX have special meanings as infinities

type Error = DateTimeConversionError

The type returned in the event of a conversion error.

fn try_from(value: DateADT) -> Result<Self, Self::Error>

Performs the conversion.

impl UnboxDatum for Date

type As<'src> = Date

Self with the lifetime 'src

unsafe fn unbox<'src>(datum: Datum<'src>) -> Self::As<'src>

where Self: 'src,

Convert from Datum<'src> to T::As<'src>

impl Copy for Date

impl Eq for Date