Struct TimeWithTimeZone

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

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

Implementations

impl TimeWithTimeZone

pub fn new( hour: u8, minute: u8, second: f64, ) -> Result<TimeWithTimeZone, DateTimeConversionError>

Construct a new TimeWithTimeZone 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(hour: u8, minute: u8, second: f64) -> TimeWithTimeZone

Construct a new TimeWithTimeZone 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>( hour: u8, minute: u8, second: f64, timezone: Tz, ) -> Result<TimeWithTimeZone, DateTimeConversionError>

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

Construct a new TimeWithTimeZone 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 with_timezone_offset( hour: u8, minute: u8, second: f64, timezone_offset: Interval, ) -> Result<TimeWithTimeZone, DateTimeConversionError>

Construct a new TimeWithTimeZone from its constituent parts at a specific time zone Interval

Errors

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

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 timezone_offset(&self) -> i32

Extract the timezone, measured in seconds past GMT

pub fn timezone_hour(&self) -> i32

Extract the timezone_hour, measured in hours past GMT

pub fn timezone_minute(&self) -> i32

Extract the timezone_minute, measured in hours past GMT

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) -> Time

Shift this TimeWithTimeZone to UTC

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

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

Shift the TimeWithTimeZone 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 into_inner(self) -> TimeTzADT

Return the backing pg_sys::TimeTzADT value.

Trait Implementations

impl Add<Date> for TimeWithTimeZone

type Output = TimestampWithTimeZone

The resulting type after applying the + operator.

fn add(self, rhs: Date) -> <TimeWithTimeZone as Add<Date>>::Output

Performs the + operation.

impl Add<Interval> for TimeWithTimeZone

type Output = TimeWithTimeZone

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<TimeWithTimeZone> for Date

type Output = TimestampWithTimeZone

The resulting type after applying the + operator.

fn add(self, rhs: TimeWithTimeZone) -> <Date as Add<TimeWithTimeZone>>::Output

Performs the + operation.

impl Add<TimeWithTimeZone> for Interval

type Output = TimeWithTimeZone

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for TimeWithTimeZone

fn clone(&self) -> TimeWithTimeZone

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TimeWithTimeZone

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TimeWithTimeZone

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TimeWithTimeZone

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

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

impl From<(i64, i32)> for TimeWithTimeZone

fn from(value: (i64, i32)) -> TimeWithTimeZone

Converts to this type from the input type.

impl From<Time> for TimeWithTimeZone

fn from(t: Time) -> TimeWithTimeZone

Converts to this type from the input type.

impl From<TimeTzADT> for TimeWithTimeZone

Create a TimeWithTimeZone from a pg_sys::TimeTzADT

This impl currently allows creating a TimeWithTimeZone that cannot be constructed by SQL, such as at the time 37:42 in the time zone UTC+25:00, which may yield logic bugs if used.

fn from(value: TimeTzADT) -> TimeWithTimeZone

Converts to this type from the input type.

impl From<TimeWithTimeZone> for Time

fn from(value: TimeWithTimeZone) -> 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 FromDatum for TimeWithTimeZone

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

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 TimeWithTimeZone

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

Create this type from a string.

type Err = DateTimeConversionError

The associated error which can be returned from parsing.

impl HasExtractableParts for TimeWithTimeZone

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

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 TimeWithTimeZone

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 TimeWithTimeZone

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

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

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

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

where S: Serializer,

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

impl SqlTranslatable for TimeWithTimeZone

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 TimeWithTimeZone

type Output = TimeWithTimeZone

The resulting type after applying the - operator.

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

Performs the - operation.

impl ToIsoString for TimeWithTimeZone

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 Copy for TimeWithTimeZone

impl Eq for TimeWithTimeZone