Struct tantivy_common::DateTime

pub struct DateTime { /* private fields */ }

A date/time value with nanoseconds 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 MIN: DateTime = _

Minimum possible DateTime value.

pub const MAX: DateTime = _

Maximum possible DateTime value.

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_timestamp_nanos(nanoseconds: i64) -> Self

Create new from UNIX timestamp in nanoseconds.

pub 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 const fn into_timestamp_nanos(self) -> i64

Convert to UNIX timestamp in nanoseconds.

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.

pub fn truncate(self, precision: DateTimePrecision) -> Self

Truncates the microseconds value to the corresponding precision.

Trait Implementations

impl BinarySerializable for DateTime

fn serialize<W: Write + ?Sized>(&self, writer: &mut W) -> Result<()>

Serialize

fn deserialize<R: Read>(reader: &mut R) -> Result<Self>

Deserialize

fn num_bytes(&self) -> u64

impl Clone for DateTime

fn clone(&self) -> DateTime

Returns a copy of the value.

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 Default for DateTime

fn default() -> DateTime

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DateTime

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for DateTime

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

Feeds this value into the given Hasher.

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 Ord for DateTime

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

This method returns an Ordering between self and other.

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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for DateTime

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

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

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 for DateTime

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

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

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

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

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

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

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

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

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 Serialize for DateTime

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for DateTime

impl Eq for DateTime

impl StructuralPartialEq for DateTime