date_validation_types 2.0.0

- Types for validating if a u32 value is valid for a day, month or year. - Type to for a valid date coming from simple integer value
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

//! # Purpose
//!
//! - Types for validating if a u32 value is valid for a day, month or year.
//! - Types for a valid date coming from simple integer value
//!
//! # Example
//!
//! ## Usage
//!
//! ```rust
//! use date_validation_types::units::{
//!     InvalidDay, InvalidMonth, InvalidYear, ValidatedDate, ValidatedDay, ValidatedMonth,
//!     ValidatedYear,
//! };
//! let valid_day: ValidatedDay = 10.try_into().unwrap();
//! let valid_month: ValidatedMonth = 10.try_into().unwrap();
//! let valid_year: ValidatedYear = 1990.try_into().unwrap();
//!
//! let valid_date = ValidatedDate::new(valid_year, valid_month, valid_day).unwrap();
//! assert_eq!(valid_date.day(), 10);
//! assert_eq!(valid_date.month(), 10);
//! assert_eq!(valid_date.year(), 1990);
//!
//! let invalid_day: Result<ValidatedDay, InvalidDay> = 32.try_into();
//! let invalid_month: Result<ValidatedMonth, InvalidMonth> = 13.try_into();
//! let invalid_year: Result<ValidatedYear, InvalidYear> = 455555555.try_into();
//! assert!(invalid_day.is_err());
//! assert!(invalid_month.is_err());
//! assert!(invalid_year.is_err());
//!
//! // Construct date via a day within a the year instead of a month
//! let ordinal_date = ValidatedDate::from_ordinal(1990, 42).unwrap();
//! assert_eq!(ordinal_date.year(), 1990);
//! assert_eq!(ordinal_date.month(), 2);
//! assert_eq!(ordinal_date.day(), 11);
//! ```

mod constants;
pub mod units;

#[cfg(feature = "chrono")]
pub use crate::units::for_chrono;
#[cfg(feature = "chrono")]
pub use chrono;

pub mod prelude {
    #[cfg(feature = "chrono")]
    pub use crate::for_chrono;

    pub use crate::units::*;
}