Struct koyomi::Date

pub struct Date { /* fields omitted */ }

日付

カレンダーのベースとなる構造体。 文字列または(年, 月, 日)から生成する。

Methods

impl Date

pub fn parse(fmt: &str) -> KoyomiResult<Self>

文字列からオブジェクトを生成する 文字列は Y-m-d か Y/m/d 形式のみ受け付ける

Examples

use koyomi::Date;

let date = Date::parse("2018-01-01");
assert!(date.is_ok());

let date = Date::parse("2018/01/01");
assert!(date.is_ok());

let date = Date::parse("2018-01-32");
assert!(date.is_err());

pub fn from_ymd(year: i32, month: u32, day: u32) -> KoyomiResult<Self>

年月日からオブジェクトを生成する

Examples

use koyomi::Date;

let date = Date::from_ymd(2018, 1, 1);
assert!(date.is_ok());

let date = Date::from_ymd(2018, 13, 1);
assert!(date.is_err());

pub fn day(&self) -> u32

「日」を返す

Examples

use koyomi::Date;

let date = Date::from_ymd(2018, 1, 31).unwrap();
assert_eq!(date.day(), 31);

pub fn era(&self) -> Option<Era>

「元号」を返す

Examples

use koyomi::Date;

let date = Date::from_ymd(2018, 1, 1).unwrap();
assert_eq!(date.era().unwrap().name(), "平成");

pub fn holiday(&self) -> Option<String>

「祝祭日」を返す

Examples

use koyomi::Date;

let date = Date::from_ymd(2018, 1, 1).unwrap();
assert_eq!(date.holiday().unwrap(), "元日");

let date = Date::from_ymd(2018, 1, 2).unwrap();
assert_eq!(date.holiday(), None);

pub fn month(&self) -> u32

「月」を返す

Examples

use koyomi::Date;

let date = Date::from_ymd(2018, 12, 1).unwrap();
assert_eq!(date.month(), 12);

pub fn num_days(&self, date: &Date) -> i64

日付間の期間が何日あるかを返す

Examples

use koyomi::Date;

let from = Date::from_ymd(2018, 1, 1).unwrap();
let until = Date::from_ymd(2018, 12, 31).unwrap();
assert_eq!(until.num_days(&from), 364);

// うるう年
let from = Date::from_ymd(2016, 1, 1).unwrap();
let until = Date::from_ymd(2016, 12, 31).unwrap();
assert_eq!(until.num_days(&from), 365);

pub fn to_string(&self) -> String

日付の文字列表現を返す フォーマットは Y-m-d 形式となる

Examples

use koyomi::Date;

let date = Date::from_ymd(2018, 1, 1).unwrap();
assert_eq!(date.to_string(), "2018-01-01");

pub fn tomorrow(&self) -> KoyomiResult<Self>

翌日の日付を返す

Examples

use koyomi::Date;

let date = Date::from_ymd(2018, 1, 1).unwrap();
let tomorrow = date.tomorrow();
assert_eq!(tomorrow.unwrap().to_string(), "2018-01-02");

pub fn weekday(&self) -> &Weekday

「曜日」を返す

Examples

use koyomi::{Date, Weekday};

let date = Date::from_ymd(2018, 1, 1).unwrap();
assert_eq!(date.weekday(), &Weekday::Monday);

pub fn year(&self) -> i32

「年」を返す

Examples

use koyomi::Date;

let date = Date::from_ymd(2018, 1, 1).unwrap();
assert_eq!(date.year(), 2018);

pub fn yesterday(&self) -> KoyomiResult<Self>

前日の日付を返す

Examples

use koyomi::Date;

let date = Date::from_ymd(2018, 1, 1).unwrap();
let yesterday = date.yesterday();
assert_eq!(yesterday.unwrap().to_string(), "2017-12-31");

Trait Implementations

impl Clone for Date

fn clone(&self) -> Date

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Date

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

Formats the value using the given formatter.

impl Display for Date

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

Formats the value using the given formatter.

impl Eq for Date

impl Ord for Date

fn cmp(&self, other: &Date) -> Ordering

日付オブジェクト同士を比較可能にする

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<Date> for Date

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Date> for Date

fn partial_cmp(&self, other: &Date) -> Option<Ordering>

日付オブジェクト同士を比較可能にする

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Date

impl StructuralPartialEq for Date