Struct Year 

pub struct Year(/* private fields */);

A year a work was published or was retrieved in, 1 or later.

A newtype for the same reason Day is one, and it was missing for the same reason Day’s bound nearly was: a bare i32 let 0 and -1 through serde, and the formatter rendered them as (0) and (-1, January 2) — strings that are not dates, printed with a date’s authority, in a module whose subject is not doing that.

Year zero is not a year in the numbering APA’s readers use, and a negative year is BCE, which APA writes as 400 B.C.E. and not as -400. Rendering either as a plain number states something false about the work, so neither is constructible. BCE dates are not modelled at all: the alternative is an era field, and half an era model is worse than none.

There is deliberately no upper bound. A year in the future is either a forthcoming work — a legitimate thing to record — or a typo, and no type can separate those without a clock. This crate has no clock and will not acquire one: a record that rendered differently next year would not be reproducible, which is a harder rule here than tidiness about typos.

Implementations

impl Year

pub fn new(year: i32) -> Option<Self>

Construct a year, rejecting zero and anything before it.

pub fn get(self) -> i32

The year number.

Trait Implementations

impl Clone for Year

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Year

impl Debug for Year

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Year

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Year

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

Formats the value using the given formatter.

impl Eq for Year

impl From<Year> for i32

fn from(year: Year) -> Self

Converts to this type from the input type.

impl Ord for Year

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Year

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Year

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Year

impl TryFrom<i32> for Year

type Error = NotAYear

The type returned in the event of a conversion error.

fn try_from(year: i32) -> Result<Self, Self::Error>

Performs the conversion.