magnus167/rustframe
1
0
Fork 0
mirror of https://github.com/Magnus167/rustframe.git synced 2025-11-22 18:16:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation to use rustframe::utils for BDatesList and DatesList

Browse Source
This commit is contained in:
Palash Tyagi
2025-04-21 01:27:41 +01:00
parent 488f101618
commit 25e3405d85
2 changed files with 39 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
src/utils/dates.rs
View File

@@ -164,7 +164,7 @@ enum GroupKey {
/// ```rust
/// use chrono::NaiveDate;
/// use std::error::Error;
/// # use dates::{DatesList, DateFreq}; // Assuming the crate/module is named 'dates'
/// # use rustframe::utils::{DatesList, DateFreq}; // Assuming the crate/module is named 'dates'
///
/// # fn main() -> Result<(), Box<dyn Error>> {
/// let start_date = "2023-11-01".to_string(); // Wednesday
@@ -194,9 +194,9 @@ enum GroupKey {
/// ```rust
/// use chrono::NaiveDate;
/// use std::error::Error;
/// # use dates::{DatesList, DateFreq};
/// use rustframe::utils::{DatesList, DateFreq};
///
/// # fn main() -> Result<(), Box<dyn Error>> {
/// fn main() -> Result<(), Box<dyn Error>> {
/// let start_date = "2024-02-28".to_string(); // Wednesday
/// let freq = DateFreq::WeeklyFriday;
/// let n_periods = 3;
@@ -224,9 +224,9 @@ enum GroupKey {
/// ```rust
/// use chrono::NaiveDate;
/// use std::error::Error;
/// # use dates::{DatesList, DateFreq};
/// use rustframe::utils::{DatesList, DateFreq};
///
/// # fn main() -> Result<(), Box<dyn Error>> {
/// fn main() -> Result<(), Box<dyn Error>> {
/// let start_date = "2023-11-20".to_string(); // Mon, Week 47
/// let end_date = "2023-12-08".to_string(); // Fri, Week 49
/// let freq = DateFreq::MonthEnd; // Find month-ends
@@ -238,8 +238,8 @@ enum GroupKey {
///
/// assert_eq!(groups.len(), 1); // Only November's end date falls in the range
/// assert_eq!(groups[0], vec![NaiveDate::from_ymd_opt(2023, 11, 30).unwrap()]); // Nov 2023 group
/// # Ok(())
/// # }
/// Ok(())
/// }
/// ```
impl DatesList {
/// Creates a new `DatesList` instance defined by a start and end date.
@@ -422,10 +422,9 @@ impl DatesList {
/// ```rust
/// use chrono::NaiveDate;
/// use std::error::Error;
/// # // Replace 'your_crate_name' with the actual name if this is in a library
/// # use dates::{DatesGenerator, DateFreq};
/// use rustframe::utils::{DatesGenerator, DateFreq};
///
/// # fn main() -> Result<(), Box<dyn Error>> {
/// fn main() -> Result<(), Box<dyn Error>> {
/// let start = NaiveDate::from_ymd_opt(2023, 12, 28).unwrap(); // Thursday
/// let freq = DateFreq::MonthEnd;
/// let n_periods = 4; // Dec '23, Jan '24, Feb '24, Mar '24
@@ -438,8 +437,8 @@ impl DatesList {
/// assert_eq!(generator.next(), Some(NaiveDate::from_ymd_opt(2024, 2, 29).unwrap())); // Leap year
/// assert_eq!(generator.next(), Some(NaiveDate::from_ymd_opt(2024, 3, 31).unwrap()));
/// assert_eq!(generator.next(), None); // Exhausted
/// # Ok(())
/// # }
/// Ok(())
/// }
/// ```
///
/// **2. Collecting into a Vec (Daily):**
@@ -447,9 +446,9 @@ impl DatesList {
/// ```rust
/// use chrono::NaiveDate;
/// use std::error::Error;
/// # use dates::{DatesGenerator, DateFreq};
/// use rustframe::utils::{DatesGenerator, DateFreq};
///
/// # fn main() -> Result<(), Box<dyn Error>> {
/// fn main() -> Result<(), Box<dyn Error>> {
/// let start = NaiveDate::from_ymd_opt(2024, 4, 29).unwrap(); // Monday
/// let freq = DateFreq::Daily;
/// let n_periods = 5;
@@ -466,8 +465,8 @@ impl DatesList {
/// ];
///
/// assert_eq!(dates, expected_dates);
/// # Ok(())
/// # }
/// Ok(())
/// }
/// ```
///
/// **3. Starting on the Exact Day (Weekly Monday):**
@@ -475,9 +474,9 @@ impl DatesList {
/// ```rust
/// use chrono::NaiveDate;
/// use std::error::Error;
/// # use dates::{DatesGenerator, DateFreq};
/// use rustframe::utils::{DatesGenerator, DateFreq};
///
/// # fn main() -> Result<(), Box<dyn Error>> {
/// fn main() -> Result<(), Box<dyn Error>> {
/// let start = NaiveDate::from_ymd_opt(2024, 1, 1).unwrap(); // Monday
/// let freq = DateFreq::WeeklyMonday;
/// let n_periods = 3;
@@ -488,8 +487,8 @@ impl DatesList {
/// assert_eq!(generator.next(), Some(NaiveDate::from_ymd_opt(2024, 1, 8).unwrap()));
/// assert_eq!(generator.next(), Some(NaiveDate::from_ymd_opt(2024, 1, 15).unwrap()));
/// assert_eq!(generator.next(), None);
/// # Ok(())
/// # }
/// Ok(())
/// }
/// ```
#[derive(Debug, Clone)]
pub struct DatesGenerator {