qubit-mixin 0.2.0

Trait mixins for domain objects, providing common properties and behaviors
Documentation
////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2025 Haixing Hu
//
//  This program is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program. If not, see <https://www.gnu.org/licenses/>.
//
////////////////////////////////////////////////////////////////////////////////

//! Traits for creation time recording functionality
//!
//! # Author
//!
//! Haixing Hu

use chrono::{DateTime, Utc};

/// A trait indicating that an entity class records the creation time
///
/// This trait provides access and setting functionality for the creation
/// time of domain objects, used to record the timestamp when an object
/// was first created.
///
/// # Example
///
/// ```rust
/// use chrono::{DateTime, Utc};
/// use qubit_mixin::Creatable;
///
/// struct Article {
///     title: String,
///     create_time: DateTime<Utc>,
/// }
///
/// impl Creatable for Article {
///     fn create_time(&self) -> DateTime<Utc> {
///         self.create_time
///     }
///
///     fn set_create_time(&mut self, time: DateTime<Utc>) {
///         self.create_time = time;
///     }
/// }
///
/// let now = Utc::now();
/// let mut article = Article {
///     title: "Hello".to_string(),
///     create_time: now,
///  };
/// assert_eq!(article.create_time(), now);
/// ```
///
/// # Author
///
/// Haixing Hu
pub trait Creatable {
    /// Gets the creation time of the current object
    ///
    /// # Returns
    ///
    /// The creation time of the current object
    fn create_time(&self) -> DateTime<Utc>;

    /// Sets the creation time of the current object
    ///
    /// # Parameters
    ///
    /// * `time` - The new creation time to be set
    fn set_create_time(&mut self, time: DateTime<Utc>);
}