Struct TimestampWithOffset 

pub struct TimestampWithOffset;

The extension type for TimestampWithOffset.

Extension name: arrow.timestamp_with_offset.

This type represents a timestamp column that stores potentially different timezone offsets per value. The timestamp is stored in UTC alongside the original timezone offset in minutes. This extension type is intended to be compatible with ANSI SQL’s TIMESTAMP WITH TIME ZONE, which is supported by multiple database engines.

The storage type of the extension is a Struct with 2 fields, in order: - timestamp: a non-nullable Timestamp(time_unit, "UTC"), where time_unit is any Arrow TimeUnit (s, ms, us or ns). - offset_minutes: a non-nullable signed 16-bit integer (Int16) representing the offset in minutes from the UTC timezone. Negative offsets represent time zones west of UTC, while positive offsets represent east. Offsets normally range from -779 (-12:59) to +780 (+13:00).

This type has no type parameters.

Metadata is either empty or an empty string.

It is also permissible for the offset_minutes field to be dictionary-encoded with a preferred (but not required) index type of int8, or run-end-encoded with a preferred (but not required) runs type of int8.

It’s worth noting that the data source needs to resolve timezone strings such as UTC or Americas/Los_Angeles into an offset in minutes in order to construct a TimestampWithOffset. This makes TimestampWithOffset type “lossy” in the sense that any original “unresolved” timezone string gets lost in this conversion. It’s a tradeoff for optimizing the row representation and simplifying the client code, which does not need to know how to convert from timezone string to its corresponding offset in minutes.

https://arrow.apache.org/docs/format/CanonicalExtensions.html#timestamp-with-offset

Trait Implementations

impl Clone for TimestampWithOffset

Available on crate feature canonical_extension_types only.

fn clone(&self) -> TimestampWithOffset

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TimestampWithOffset

Available on crate feature canonical_extension_types only.

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

Formats the value using the given formatter.

impl Default for TimestampWithOffset

Available on crate feature canonical_extension_types only.

fn default() -> TimestampWithOffset

Returns the “default value” for a type.

impl ExtensionType for TimestampWithOffset

Available on crate feature canonical_extension_types only.

const NAME: &'static str = "arrow.timestamp_with_offset"

The name identifying this extension type.

type Metadata = ()

The metadata type of this extension type.

fn metadata(&self) -> &Self::Metadata

Returns a reference to the metadata of this extension type, or &() if if this extension type defines no metadata (Self::Metadata=()).

fn serialize_metadata(&self) -> Option<String>

Returns the serialized representation of the metadata of this extension type, or None if this extension type defines no metadata (Self::Metadata=()).

fn deserialize_metadata( metadata: Option<&str>, ) -> Result<Self::Metadata, ArrowError>

Deserialize the metadata of this extension type from the serialized representation of the metadata. An extension type that defines no metadata should expect None for the serialized metadata and return Ok(()).

fn supports_data_type(&self, data_type: &DataType) -> Result<(), ArrowError>

Returns Ok(()) iff the given data type is supported by this extension type.

fn try_new( data_type: &DataType, _metadata: Self::Metadata, ) -> Result<Self, ArrowError>

Construct this extension type for a field with the given data type and metadata.

fn try_new_from_field_metadata( data_type: &DataType, metadata: &HashMap<String, String>, ) -> Result<Self, ArrowError>

Construct this extension type from field metadata and data type.

impl From<TimestampWithOffset> for CanonicalExtensionType

Available on crate feature canonical_extension_types only.

fn from(value: TimestampWithOffset) -> Self

Converts to this type from the input type.

impl PartialEq for TimestampWithOffset

Available on crate feature canonical_extension_types only.

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

Available on crate feature canonical_extension_types only.

impl StructuralPartialEq for TimestampWithOffset

Available on crate feature canonical_extension_types only.