Struct TimestampWithTimeZone

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

A safe wrapper around Postgres TIMESTAMP WITH TIME ZONE type, backed by a pg_sys::Timestamp integer value.

Implementations

impl TimestampWithTimeZone

pub fn new( year: i32, month: u8, day: u8, hour: u8, minute: u8, second: f64, ) -> Result<TimestampWithTimeZone, DateTimeConversionError>

Construct a new TimestampWithTimeZone from its constituent parts.

Notes

This function uses Postgres’ “current time zone”

Errors

Returns a DateTimeConversionError if any part is outside the bounds for that part

pub fn new_unchecked( year: isize, month: u8, day: u8, hour: u8, minute: u8, second: f64, ) -> TimestampWithTimeZone

Construct a new TimestampWithTimeZone from its constituent parts.

Elides the overhead of trapping errors for out-of-bounds parts

Notes

This function uses Postgres’ “current time zone”

Panics

This function panics if any part is out-of-bounds

pub fn with_timezone<Tz>( year: i32, month: u8, day: u8, hour: u8, minute: u8, second: f64, timezone: Tz, ) -> Result<TimestampWithTimeZone, DateTimeConversionError>

where Tz: AsRef<str> + UnwindSafe + RefUnwindSafe,

Construct a new TimestampWithTimeZone from its constituent parts at a specific time zone

Errors

Returns a DateTimeConversionError if any part is outside the bounds for that part

pub fn positive_infinity() -> TimestampWithTimeZone

Construct a new TimestampWithTimeZone representing positive infinity

pub fn negative_infinity() -> TimestampWithTimeZone

Construct a new TimestampWithTimeZone representing negative infinity

pub fn is_infinity(&self) -> bool

Does this TimestampWithTimeZone represent positive infinity?

pub fn is_neg_infinity(&self) -> bool

Does this TimestampWithTimeZone represent negative infinity?

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 hour(&self) -> u8

Extract the hour

pub fn minute(&self) -> u8

Extract the minute

pub fn second(&self) -> f64

Extract the second

pub fn microseconds(&self) -> u32

Return the microseconds part. This is not the time counted in microseconds, but the fractional seconds

pub fn to_hms_micro(&self) -> (u8, u8, u8, u32)

Return the hour, minute, second, and microseconds as a Rust tuple

pub fn to_utc(&self) -> Timestamp

Shift the Timestamp to the UTC time zone

pub fn at_timezone<Tz>( &self, timezone: Tz, ) -> Result<Timestamp, DateTimeConversionError>

where Tz: AsRef<str> + UnwindSafe + RefUnwindSafe,

Shift the TimestampWithTimeZone to the specified time zone

Errors

Returns a DateTimeConversionError if the specified time zone is invalid or if for some other reason the underlying time cannot be represented in the specified time zone

pub fn is_finite(&self) -> bool

pub fn truncate(self, units: DateTimeParts) -> TimestampWithTimeZone

Truncate TimestampWithTimeZone to specified units

pub fn truncate_with_time_zone<Tz>( self, units: DateTimeParts, zone: Tz, ) -> TimestampWithTimeZone

where Tz: AsRef<str>,

Truncate TimestampWithTimeZone to specified units in specified time zone

Not available under Postgres v11

pub fn age(&self, other: &TimestampWithTimeZone) -> Interval

Subtract other from self, producing a “symbolic” result that uses years and months, rather than just days

pub fn into_inner(self) -> i64

Return the backing pg_sys::TimestampTz value.

Trait Implementations

impl Add<Interval> for TimestampWithTimeZone

type Output = TimestampWithTimeZone

The resulting type after applying the + operator.

fn add(self, rhs: Interval) -> <TimestampWithTimeZone as Add<Interval>>::Output

Performs the + operation.

impl Add<TimestampWithTimeZone> for Interval

type Output = TimestampWithTimeZone

The resulting type after applying the + operator.

fn add( self, rhs: TimestampWithTimeZone, ) -> <Interval as Add<TimestampWithTimeZone>>::Output

Performs the + operation.

impl Clone for TimestampWithTimeZone

fn clone(&self) -> TimestampWithTimeZone

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TimestampWithTimeZone

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TimestampWithTimeZone

fn deserialize<D>( deserializer: D, ) -> Result<TimestampWithTimeZone, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TimestampWithTimeZone

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

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

impl From<Date> for TimestampWithTimeZone

fn from(value: Date) -> TimestampWithTimeZone

Converts to this type from the input type.

impl From<Timestamp> for TimestampWithTimeZone

fn from(value: Timestamp) -> TimestampWithTimeZone

Converts to this type from the input type.

impl From<TimestampWithTimeZone> for Date

fn from(value: TimestampWithTimeZone) -> Date

Converts to this type from the input type.

impl From<TimestampWithTimeZone> for Time

fn from(value: TimestampWithTimeZone) -> Time

Converts to this type from the input type.

impl From<TimestampWithTimeZone> for TimeWithTimeZone

fn from(value: TimestampWithTimeZone) -> TimeWithTimeZone

Converts to this type from the input type.

impl From<TimestampWithTimeZone> for Timestamp

fn from(value: TimestampWithTimeZone) -> Timestamp

Converts to this type from the input type.

impl FromDatum for TimestampWithTimeZone

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

where TimestampWithTimeZone: 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>

where Self: Sized,

Safety

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

where Self: Sized,

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: Sized + 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: Sized + IntoDatum,

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

impl FromStr for TimestampWithTimeZone

fn from_str( s: &str, ) -> Result<TimestampWithTimeZone, <TimestampWithTimeZone as FromStr>::Err>

Create this type from a string.

type Err = DateTimeConversionError

The associated error which can be returned from parsing.

impl HasExtractableParts for TimestampWithTimeZone

const EXTRACT_FUNCTION: unsafe fn(*mut FunctionCallInfoBaseData) -> Datum = {pgrx::pg_sys::extract_timestamptz 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 TimestampWithTimeZone

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

where H: Hasher,

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 TimestampWithTimeZone

fn into_datum(self) -> Option<Datum>

fn type_oid() -> Oid

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

fn array_type_oid() -> Oid

fn is_compatible_with(other: Oid) -> bool

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

impl Ord for TimestampWithTimeZone

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

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

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

for Timestamp With Time Zone/tstzrange

fn range_type_oid() -> Oid

impl Serialize for TimestampWithTimeZone

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

where S: Serializer,

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

impl SqlTranslatable for TimestampWithTimeZone

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 TimestampWithTimeZone

type Output = TimestampWithTimeZone

The resulting type after applying the - operator.

fn sub(self, rhs: Interval) -> <TimestampWithTimeZone as Sub<Interval>>::Output

Performs the - operation.

impl Sub for TimestampWithTimeZone

type Output = Interval

The resulting type after applying the - operator.

fn sub( self, rhs: TimestampWithTimeZone, ) -> <TimestampWithTimeZone as Sub>::Output

Performs the - operation.

impl ToIsoString for TimestampWithTimeZone

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>( self, timezone: Tz, ) -> Result<String, DateTimeConversionError>

where Tz: AsRef<str>,

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

impl<Tz> TryFrom<(Timestamp, Tz)> for TimestampWithTimeZone

where Tz: AsRef<str> + UnwindSafe + RefUnwindSafe,

Create a TimestampWithTimeZone from an existing Timestamp (which is understood to be in the “current time zone” and a time zone string.

type Error = DateTimeConversionError

The type returned in the event of a conversion error.

fn try_from( value: (Timestamp, Tz), ) -> Result<TimestampWithTimeZone, <TimestampWithTimeZone as TryFrom<(Timestamp, Tz)>>::Error>

Performs the conversion.

impl TryFrom<Datum> for TimestampWithTimeZone

type Error = FromTimeError

The type returned in the event of a conversion error.

fn try_from( datum: Datum, ) -> Result<TimestampWithTimeZone, <TimestampWithTimeZone as TryFrom<Datum>>::Error>

Performs the conversion.

impl TryFrom<i64> for TimestampWithTimeZone

Fallibly create a [TimestampWithTimeZone] from a Postgres pg_sys::TimestampTz value.

type Error = FromTimeError

The type returned in the event of a conversion error.

fn try_from( value: i64, ) -> Result<TimestampWithTimeZone, <TimestampWithTimeZone as TryFrom<i64>>::Error>

Performs the conversion.

impl Copy for TimestampWithTimeZone

impl Eq for TimestampWithTimeZone