Struct JPHoliday 

pub struct JPHoliday { /* private fields */ }

日本の祝日を判定するクラス。

判定結果は日付単位でキャッシュされます。 キャッシュは問い合わせた日付ごとに増えるため、多数の日付を問い合わせる場合はインスタンスを drop することでまとめて解放できます（グローバル関数 API はキャッシュを持ちません）。

Examples

use jpholiday::{Date, JPHoliday};

let jp = JPHoliday::new();
assert!(jp.is_holiday(Date::new(2017, 1, 1).unwrap()));
assert_eq!(
    jp.is_holiday_name(Date::new(2017, 1, 2).unwrap()).as_deref(),
    Some("元日 振替休日")
);

Implementations

impl JPHoliday

pub fn new() -> Self

既定のチェッカーを備えた新しいインスタンスを生成します。

Examples found in repository

examples/basic.rs (line 36)

fn main() {
    // --- 関数 API ---
    let new_year = Date::new(2017, 1, 1).unwrap();
    println!("{new_year} は祝日? {}", jpholiday::is_holiday(new_year));
    println!(
        "{} の祝日名: {:?}",
        Date::new(2017, 1, 2).unwrap(),
        jpholiday::is_holiday_name(Date::new(2017, 1, 2).unwrap())
    );

    println!("\n2017 年の祝日一覧:");
    for (date, name) in jpholiday::year_holidays(2017) {
        println!("  {date}  {name}");
    }

    println!("\n2017 年 5 月の祝日:");
    for (date, name) in jpholiday::month_holidays(2017, 5) {
        println!("  {date}  {name}");
    }

    println!("\nゴールデンウィーク (2017-05-01 〜 2017-05-05):");
    for (date, name) in jpholiday::between(
        Date::new(2017, 5, 1).unwrap(),
        Date::new(2017, 5, 5).unwrap(),
    ) {
        println!("  {date}  {name}");
    }

    // --- クラス API ---
    let jp = JPHoliday::new();
    let holidays = jp.holidays(Date::new(2020, 1, 1).unwrap());
    println!("\nクラス API: {:?}", holidays);

    // --- 独自祝日 ---
    struct CompanyHoliday;
    impl OriginalHolidayChecker for CompanyHoliday {
        fn is_holiday(&self, date: Date) -> bool {
            date == Date::new(2020, 2, 9).unwrap()
        }
        fn holiday_name(&self, _date: Date) -> String {
            "特別休暇".to_string()
        }
    }

    let mut jp = JPHoliday::new();
    jp.register(CompanyHoliday);
    let special = Date::new(2020, 2, 9).unwrap();
    println!(
        "\n独自祝日を登録: {} -> {:?}",
        special,
        jp.is_holiday_name(special)
    );
    jp.unregister::<CompanyHoliday>();
    println!(
        "登録解除後: {} -> {:?}",
        special,
        jp.is_holiday_name(special)
    );
}

pub fn holidays(&self, date: Date) -> Vec<Holiday>

その日に該当するすべての祝日を返します。

Examples found in repository

examples/basic.rs (line 37)

fn main() {
    // --- 関数 API ---
    let new_year = Date::new(2017, 1, 1).unwrap();
    println!("{new_year} は祝日? {}", jpholiday::is_holiday(new_year));
    println!(
        "{} の祝日名: {:?}",
        Date::new(2017, 1, 2).unwrap(),
        jpholiday::is_holiday_name(Date::new(2017, 1, 2).unwrap())
    );

    println!("\n2017 年の祝日一覧:");
    for (date, name) in jpholiday::year_holidays(2017) {
        println!("  {date}  {name}");
    }

    println!("\n2017 年 5 月の祝日:");
    for (date, name) in jpholiday::month_holidays(2017, 5) {
        println!("  {date}  {name}");
    }

    println!("\nゴールデンウィーク (2017-05-01 〜 2017-05-05):");
    for (date, name) in jpholiday::between(
        Date::new(2017, 5, 1).unwrap(),
        Date::new(2017, 5, 5).unwrap(),
    ) {
        println!("  {date}  {name}");
    }

    // --- クラス API ---
    let jp = JPHoliday::new();
    let holidays = jp.holidays(Date::new(2020, 1, 1).unwrap());
    println!("\nクラス API: {:?}", holidays);

    // --- 独自祝日 ---
    struct CompanyHoliday;
    impl OriginalHolidayChecker for CompanyHoliday {
        fn is_holiday(&self, date: Date) -> bool {
            date == Date::new(2020, 2, 9).unwrap()
        }
        fn holiday_name(&self, _date: Date) -> String {
            "特別休暇".to_string()
        }
    }

    let mut jp = JPHoliday::new();
    jp.register(CompanyHoliday);
    let special = Date::new(2020, 2, 9).unwrap();
    println!(
        "\n独自祝日を登録: {} -> {:?}",
        special,
        jp.is_holiday_name(special)
    );
    jp.unregister::<CompanyHoliday>();
    println!(
        "登録解除後: {} -> {:?}",
        special,
        jp.is_holiday_name(special)
    );
}

pub fn is_holiday(&self, date: Date) -> bool

その日が祝日かどうかを返します。

pub fn is_holiday_name(&self, date: Date) -> Option<String>

その日の祝日名を返します（複数該当する場合は先頭、該当しなければ None）。

Examples found in repository

examples/basic.rs (line 57)

fn main() {
    // --- 関数 API ---
    let new_year = Date::new(2017, 1, 1).unwrap();
    println!("{new_year} は祝日? {}", jpholiday::is_holiday(new_year));
    println!(
        "{} の祝日名: {:?}",
        Date::new(2017, 1, 2).unwrap(),
        jpholiday::is_holiday_name(Date::new(2017, 1, 2).unwrap())
    );

    println!("\n2017 年の祝日一覧:");
    for (date, name) in jpholiday::year_holidays(2017) {
        println!("  {date}  {name}");
    }

    println!("\n2017 年 5 月の祝日:");
    for (date, name) in jpholiday::month_holidays(2017, 5) {
        println!("  {date}  {name}");
    }

    println!("\nゴールデンウィーク (2017-05-01 〜 2017-05-05):");
    for (date, name) in jpholiday::between(
        Date::new(2017, 5, 1).unwrap(),
        Date::new(2017, 5, 5).unwrap(),
    ) {
        println!("  {date}  {name}");
    }

    // --- クラス API ---
    let jp = JPHoliday::new();
    let holidays = jp.holidays(Date::new(2020, 1, 1).unwrap());
    println!("\nクラス API: {:?}", holidays);

    // --- 独自祝日 ---
    struct CompanyHoliday;
    impl OriginalHolidayChecker for CompanyHoliday {
        fn is_holiday(&self, date: Date) -> bool {
            date == Date::new(2020, 2, 9).unwrap()
        }
        fn holiday_name(&self, _date: Date) -> String {
            "特別休暇".to_string()
        }
    }

    let mut jp = JPHoliday::new();
    jp.register(CompanyHoliday);
    let special = Date::new(2020, 2, 9).unwrap();
    println!(
        "\n独自祝日を登録: {} -> {:?}",
        special,
        jp.is_holiday_name(special)
    );
    jp.unregister::<CompanyHoliday>();
    println!(
        "登録解除後: {} -> {:?}",
        special,
        jp.is_holiday_name(special)
    );
}

pub fn year_holidays(&self, year: i32) -> Vec<Holiday>

その年のすべての祝日を返します。

pub fn month_holidays(&self, year: i32, month: u32) -> Vec<Holiday>

その月のすべての祝日を返します。month が範囲外なら空を返します。

pub fn between(&self, start: Date, end: Date) -> Vec<Holiday>

指定範囲（両端を含む）のすべての祝日を返します。

pub fn register<C: OriginalHolidayChecker + 'static>(&mut self, checker: C)

独自の祝日チェッカーを登録します。

同一型のチェッカーが既に登録されている場合は何もしません。

Examples found in repository

examples/basic.rs (line 52)

fn main() {
    // --- 関数 API ---
    let new_year = Date::new(2017, 1, 1).unwrap();
    println!("{new_year} は祝日? {}", jpholiday::is_holiday(new_year));
    println!(
        "{} の祝日名: {:?}",
        Date::new(2017, 1, 2).unwrap(),
        jpholiday::is_holiday_name(Date::new(2017, 1, 2).unwrap())
    );

    println!("\n2017 年の祝日一覧:");
    for (date, name) in jpholiday::year_holidays(2017) {
        println!("  {date}  {name}");
    }

    println!("\n2017 年 5 月の祝日:");
    for (date, name) in jpholiday::month_holidays(2017, 5) {
        println!("  {date}  {name}");
    }

    println!("\nゴールデンウィーク (2017-05-01 〜 2017-05-05):");
    for (date, name) in jpholiday::between(
        Date::new(2017, 5, 1).unwrap(),
        Date::new(2017, 5, 5).unwrap(),
    ) {
        println!("  {date}  {name}");
    }

    // --- クラス API ---
    let jp = JPHoliday::new();
    let holidays = jp.holidays(Date::new(2020, 1, 1).unwrap());
    println!("\nクラス API: {:?}", holidays);

    // --- 独自祝日 ---
    struct CompanyHoliday;
    impl OriginalHolidayChecker for CompanyHoliday {
        fn is_holiday(&self, date: Date) -> bool {
            date == Date::new(2020, 2, 9).unwrap()
        }
        fn holiday_name(&self, _date: Date) -> String {
            "特別休暇".to_string()
        }
    }

    let mut jp = JPHoliday::new();
    jp.register(CompanyHoliday);
    let special = Date::new(2020, 2, 9).unwrap();
    println!(
        "\n独自祝日を登録: {} -> {:?}",
        special,
        jp.is_holiday_name(special)
    );
    jp.unregister::<CompanyHoliday>();
    println!(
        "登録解除後: {} -> {:?}",
        special,
        jp.is_holiday_name(special)
    );
}

pub fn unregister<C: OriginalHolidayChecker + 'static>(&mut self)

指定型の独自祝日チェッカーを登録解除します。

登録解除は型パラメータで指定します（例: jp.unregister::<MyHoliday>()）。

Examples found in repository

examples/basic.rs (line 59)

fn main() {
    // --- 関数 API ---
    let new_year = Date::new(2017, 1, 1).unwrap();
    println!("{new_year} は祝日? {}", jpholiday::is_holiday(new_year));
    println!(
        "{} の祝日名: {:?}",
        Date::new(2017, 1, 2).unwrap(),
        jpholiday::is_holiday_name(Date::new(2017, 1, 2).unwrap())
    );

    println!("\n2017 年の祝日一覧:");
    for (date, name) in jpholiday::year_holidays(2017) {
        println!("  {date}  {name}");
    }

    println!("\n2017 年 5 月の祝日:");
    for (date, name) in jpholiday::month_holidays(2017, 5) {
        println!("  {date}  {name}");
    }

    println!("\nゴールデンウィーク (2017-05-01 〜 2017-05-05):");
    for (date, name) in jpholiday::between(
        Date::new(2017, 5, 1).unwrap(),
        Date::new(2017, 5, 5).unwrap(),
    ) {
        println!("  {date}  {name}");
    }

    // --- クラス API ---
    let jp = JPHoliday::new();
    let holidays = jp.holidays(Date::new(2020, 1, 1).unwrap());
    println!("\nクラス API: {:?}", holidays);

    // --- 独自祝日 ---
    struct CompanyHoliday;
    impl OriginalHolidayChecker for CompanyHoliday {
        fn is_holiday(&self, date: Date) -> bool {
            date == Date::new(2020, 2, 9).unwrap()
        }
        fn holiday_name(&self, _date: Date) -> String {
            "特別休暇".to_string()
        }
    }

    let mut jp = JPHoliday::new();
    jp.register(CompanyHoliday);
    let special = Date::new(2020, 2, 9).unwrap();
    println!(
        "\n独自祝日を登録: {} -> {:?}",
        special,
        jp.is_holiday_name(special)
    );
    jp.unregister::<CompanyHoliday>();
    println!(
        "登録解除後: {} -> {:?}",
        special,
        jp.is_holiday_name(special)
    );
}

Trait Implementations

impl Default for JPHoliday

fn default() -> Self

Returns the “default value” for a type.