Expand description
§Romcal - Liturgical Calendar Library
A Rust library for calculating Catholic liturgical dates and seasons.
§Quick Start
use romcal::{Romcal, LiturgicalDates};
let romcal = Romcal::default();
let dates = LiturgicalDates::new(romcal, 2024).unwrap();
let easter = dates.get_easter_sunday_date_unwrap(None);Re-exports§
pub use engine::calendar::Calendar;pub use engine::calendar::LiturgicalCalendar;pub use engine::dates::LiturgicalDates;pub use engine::proper_of_time::ProperOfTime;pub use engine::template_resolver::GrammaticalGender;pub use engine::template_resolver::ProperOfTimeDayType;pub use engine::template_resolver::TemplateResolver;pub use entity_resolution::EntityResolver;pub use error::RomcalError;pub use error::RomcalResult;pub use error::Validate;pub use error::validate_range;pub use error::validate_year;pub use generated::calendar_ids::CALENDAR_IDS;pub use generated::locale_ids::LOCALE_CODES;pub use generated::schemas;pub use helpers::merge_calendar_definitions;pub use helpers::merge_resource_files;pub use romcal::Preset;pub use romcal::Romcal;pub use types::entity::SaintCount;pub use types::entity::Entity;pub use types::entity::EntityId;pub use types::liturgical::Season;pub use types::mass::CelebrationSummary;pub use types::mass::MassCalendar;pub use types::mass::MassContext;pub use types::mass::MassInfo;pub use types::mass::MassTime;pub use types::CalendarContext;pub use types::EasterCalculationType;pub use types::dates::DateDefWithOffset;pub use types::dates::DayOfWeek;pub use types::dates::MonthIndex;pub use types::liturgical::SundayCycleCombined;pub use types::mass::Acclamation;pub use types::mass::BibleBook;pub use types::mass::LiturgicalCycle;pub use types::mass::MassPart;pub use entity_search::EntityMatcher;pub use entity_search::EntityQuery;pub use entity_search::EntitySearchResult;pub use entity_search::MatchType;pub use engine::calendar_definition::*;pub use engine::liturgical_day::*;pub use engine::resources::*;
Modules§
- engine
- Core engine for liturgical calendar generation.
- entity_
resolution - Entity resolution module.
- entity_
search - Entity search module with fuzzy matching support.
- error
- Error management for Romcal
- generated
- Auto-generated constants.
- helpers
- Helper functions for merging resource and calendar definition files.
- romcal
- Core Romcal configuration and instance management.
- types
- Type definitions for the Romcal liturgical calendar library.
Constants§
- VERSION
- The version of the romcal library.