Struct tantivy::DateTime

pub struct DateTime { /* private fields */ }

A date/time value with microsecond precision.

This timestamp does not carry any explicit time zone information. Users are responsible for applying the provided conversion functions consistently. Internally the time zone is assumed to be UTC, which is also used implicitly for JSON serialization.

All constructors and conversions are provided as explicit functions and not by implementing any From/Into traits to prevent unintended usage.

Implementations

impl DateTime

pub const fn from_timestamp_secs(seconds: i64) -> Self

Create new from UNIX timestamp in seconds

pub const fn from_timestamp_millis(milliseconds: i64) -> Self

Create new from UNIX timestamp in milliseconds

pub const fn from_timestamp_micros(microseconds: i64) -> Self

Create new from UNIX timestamp in microseconds.

pub const fn from_utc(dt: OffsetDateTime) -> Self

Create new from OffsetDateTime

The given date/time is converted to UTC and the actual time zone is discarded.

pub fn from_primitive(dt: PrimitiveDateTime) -> Self

Create new from PrimitiveDateTime

Implicitly assumes that the given date/time is in UTC! Otherwise the original value must only be reobtained with Self::into_primitive().

pub const fn into_timestamp_secs(self) -> i64

Convert to UNIX timestamp in seconds.

pub const fn into_timestamp_millis(self) -> i64

Convert to UNIX timestamp in milliseconds.

pub const fn into_timestamp_micros(self) -> i64

Convert to UNIX timestamp in microseconds.

pub fn into_utc(self) -> OffsetDateTime

Convert to UTC OffsetDateTime

pub fn into_offset(self, offset: UtcOffset) -> OffsetDateTime

Convert to OffsetDateTime with the given time zone

pub fn into_primitive(self) -> PrimitiveDateTime

Convert to PrimitiveDateTime without any time zone

The value should have been constructed with Self::from_primitive(). Otherwise the time zone is implicitly assumed to be UTC.

Trait Implementations

impl Clone for DateTime

fn clone(&self) -> DateTime

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DateTime

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

Formats the value using the given formatter.

impl FastValue for DateTime

fn to_type() -> Type

Returns the schema::Type for this FastValue.

fn make_zero() -> Self

Build a default value. This default value is never used, so the value does not really matter.

impl From<DateTime> for Value

fn from(dt: DateTime) -> Value

Converts to this type from the input type.

impl MonotonicallyMappableToU64 for DateTime

fn to_u64(self) -> u64

Converts a value to u64.

fn from_u64(val: u64) -> Self

Converts a value from u64

impl Ord for DateTime

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

This method returns an [Ordering] between self and other.

const fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

const fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<DateTime> for DateTime

fn eq(&self, other: &DateTime) -> bool

This method tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<DateTime> for DateTime

fn partial_cmp(&self, other: &DateTime) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

const fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

const fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

const fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

const fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for DateTime

impl Eq for DateTime

impl StructuralEq for DateTime

impl StructuralPartialEq for DateTime