Enum CalendarPeriod 

#[repr(i32)]
pub enum CalendarPeriod {
    Unspecified = 0,
    Day = 1,
    Week = 2,
    Fortnight = 3,
    Month = 4,
    Quarter = 5,
    Half = 6,
    Year = 7,
}

A CalendarPeriod represents the abstract concept of a time period that has a canonical start. Grammatically, “the start of the current CalendarPeriod.” All calendar times begin at midnight UTC.

Variants

Unspecified = 0

Undefined period, raises an error.

Day = 1

A day.

Week = 2

A week. Weeks begin on Monday, following ISO 8601.

Fortnight = 3

A fortnight. The first calendar fortnight of the year begins at the start of week 1 according to ISO 8601.

Month = 4

A month.

Quarter = 5

A quarter. Quarters start on dates 1-Jan, 1-Apr, 1-Jul, and 1-Oct of each year.

Half = 6

A half-year. Half-years start on dates 1-Jan and 1-Jul.

Year = 7

A year.

Implementations

impl CalendarPeriod

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of CalendarPeriod.

pub fn from_i32(value: i32) -> Option<CalendarPeriod>

👎Deprecated: Use the TryFrom<i32> implementation instead

Converts an i32 to a CalendarPeriod, or None if value is not a valid variant.

impl CalendarPeriod

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

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

impl CalendarPeriod

pub const fn is_unspecified(&self) -> bool

Checks if the value is of the unspecified variant.

pub const fn is_day(&self) -> bool

Checks if the calendar period is a day.

pub const fn is_week(&self) -> bool

Checks if the calendar period is a week.

pub const fn is_fortnight(&self) -> bool

Checks if the calendar period is a fortnight.

pub const fn is_month(&self) -> bool

Checks if the calendar period is a month.

pub const fn is_quarter(&self) -> bool

Checks if the calendar period is a quarter.

pub const fn is_half(&self) -> bool

Checks if the calendar period is a half-year.

pub const fn is_year(&self) -> bool

Checks if the calendar period is a year.

Trait Implementations

impl Clone for CalendarPeriod

fn clone(&self) -> CalendarPeriod

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CalendarPeriod

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

Formats the value using the given formatter.

impl Default for CalendarPeriod

fn default() -> CalendarPeriod

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CalendarPeriod

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CalendarPeriod> for i32

fn from(value: CalendarPeriod) -> i32

Converts to this type from the input type.

impl Hash for CalendarPeriod

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 CalendarPeriod

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

Restrict a value to a certain interval.

impl PartialEq for CalendarPeriod

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

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

Available on crate feature serde only.

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<i32> for CalendarPeriod

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<CalendarPeriod, UnknownEnumValue>

Performs the conversion.

impl Copy for CalendarPeriod

impl Eq for CalendarPeriod

impl StructuralPartialEq for CalendarPeriod