Enum TimePeriod 

pub enum TimePeriod {
    Year,
    Month,
    Week,
    Day,
    Hour,
    Minute,
    Second,
    Millisecond,
    Microsecond,
}

TimePeriod

Calendar granularity for internal datetime mechanics such as truncation and flooring.

Role

TimePeriod names the granularity a datetime is floored to, for example flooring to the start of the month. It drives the internal date arithmetic in DatetimeArray and is not part of the Apache Arrow type system.

For stored resolution and FFI, use TimeUnit instead - that is the Apache Arrow and FFI-compatible unit carried on Field and ArrowType. TimePeriod is a distinct concept: it names a calendar step, not the resolution of a stored value.

String form

Each variant has a canonical lower-case label (year, month, week, day, hour, minute, second, millisecond, microsecond). A TimePeriod converts to and from that label, so a call site can pass either the variant or its string. Parse an untrusted string with str::parse (via FromStr) to get a Result - the From<&str> path panics on an unknown label and is for known-good literals.

Variants

Year

Month

Week

Day

Hour

Minute

Second

Millisecond

Microsecond

Implementations

impl TimePeriod

pub const fn as_str(&self) -> &'static str

The canonical lower-case label for this period.

Trait Implementations

impl Clone for TimePeriod

fn clone(&self) -> TimePeriod

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TimePeriod

impl Debug for TimePeriod

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

Formats the value using the given formatter.

impl Display for TimePeriod

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

Formats the value using the given formatter.

impl Eq for TimePeriod

impl From<&str> for TimePeriod

fn from(value: &str) -> Self

Converts to this type from the input type.

impl FromStr for TimePeriod

type Err = MinarrowError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for TimePeriod

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 PartialEq for TimePeriod

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