Struct YearWeek

pub struct YearWeek { /* private fields */ }

A week date consisting of a year and a week number.

Examples

use whatwg_datetime::{parse_week, YearWeek};

assert_eq!(parse_week("2011-W47"), YearWeek::new_opt(2011, 47));

Implementations

impl YearWeek

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

Creates a new YearWeek from a year and a week number.

This asserts that the year is greater than 0 and that the week number is in the valid range for the year. Specifically, the week number must be between 1 and the number of weeks in the year, inclusive.

The number of weeks in a year is described by the algorithm in [WHATWG HTML Standard § 2.3.5.8 Weeks][whatwg-html-weeks].

Examples

use whatwg_datetime::YearWeek;

assert!(YearWeek::new_opt(2004, 53).is_some());
assert!(YearWeek::new_opt(2011, 47).is_some());
assert!(YearWeek::new_opt(2011, 53).is_none()); // 2011 only has 52 weeks
assert!(YearWeek::new_opt(1952, 0).is_none()); // Week number must be at least 1
assert!(YearWeek::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::YearWeek;

let year_week = YearWeek::new_opt(2004, 53).unwrap();
assert_eq!(year_week.year(), 2004);

pub const fn week(&self) -> u32

A week component. This is a number between 1 and the number of weeks in the year, inclusive.

Examples

use whatwg_datetime::YearWeek;

let year_week = YearWeek::new_opt(2004, 53).unwrap();
assert_eq!(year_week.week(), 53);

Trait Implementations

impl Clone for YearWeek

fn clone(&self) -> YearWeek

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for YearWeek

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

Formats the value using the given formatter.

impl PartialEq for YearWeek

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

impl Eq for YearWeek

impl StructuralPartialEq for YearWeek