Struct YearMonth

pub struct YearMonth { /* private fields */ }

A proleptic-Gregorian date consisting of a year and a month, with no time-zone or date information.

Examples

use whatwg_datetime::{parse_month, YearMonth};

assert_eq!(parse_month("2011-11"), YearMonth::new_opt(2011, 11));

Implementations

impl YearMonth

pub fn new_opt(year: i32, month: u32) -> Option<Self>

Creates a new YearMonth from a year and a month number.

This asserts that:

• the year is greater than 0
• that the month number is between 1 and 12, inclusive

Examples

use whatwg_datetime::YearMonth;

assert!(YearMonth::new_opt(2011, 11).is_some());
assert!(YearMonth::new_opt(2011, 0).is_none()); // Month number must be at least 1
assert!(YearMonth::new_opt(0, 1).is_none()); // Year number must be greater than 0

pub const fn year(&self) -> i32

A year component. This is a number greater than 0.

Examples

use whatwg_datetime::YearMonth;

let year_month = YearMonth::new_opt(2011, 11).unwrap();
assert_eq!(year_month.year(), 2011);

pub const fn month(&self) -> u32

A month component. This is a number from 1 to 12, inclusive.

Examples

use whatwg_datetime::YearMonth;

let year_month = YearMonth::new_opt(2011, 11).unwrap();
assert_eq!(year_month.month(), 11);

Trait Implementations

impl Clone for YearMonth

fn clone(&self) -> YearMonth

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for YearMonth

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

Formats the value using the given formatter.

impl PartialEq for YearMonth

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

impl Eq for YearMonth

impl StructuralPartialEq for YearMonth