DateTime (DTT)

A Rust library for parsing, validating, manipulating, and formatting dates and times

Part of the Mini Functions family of libraries.

• Website • Documentation • Report Bug • Request Feature • Contributing Guidelines

Overview 📖

The DateTime (DTT) library is a comprehensive and flexible tool that enables developers to manage dates and times with ease.

It offers a range of functions and data structures that allow you to perform various date and time operations with ease, such as determining the day of the month, hour of the day, working with ISO 8601 date and time formats, and many others.

The library supports the creation of new DateTime objects with either UTC or custom timezone specifications, ensuring that you always have accurate and relevant date and time information. Additionally, it provides a mechanism to validate input dates and times, ensuring that you always have accurate information to work with.

Features ✨

The library DateTime (DTT) provides date and time types and methods to make it easier to manipulate dates and times. It uses the serde library to derive the Deserialize and Serialize traits to convert the DateTime (DTT) struct to and from various data formats. It also uses the time and regex crates to deal with time conversions and regular expressions respectively.

The DateTime (DTT) struct includes fields such as:

Each of which represents different aspects of a date and time.

The DateTime (DTT) struct has two methods to create instances: new and new_with_tz. new creates a new DateTime (DTT) object with UTC timezone, and new_with_tz creates a new DateTime (DTT) object with a custom timezone.

It also includes a method is_valid_day which checks if the input string represents a valid day of the week. It also includes a method is_valid_month which checks if the input string represents a valid month of the year.

Getting Started 🚀

It takes just a few minutes to get up and running with DateTime (DTT).

Installation

To install DateTime (DTT), you need to have the Rust toolchain installed on your machine. You can install the Rust toolchain by following the instructions on the Rust website.

Once you have the Rust toolchain installed, you can install DateTime (DTT) using the following command:

cargo install dtt

You can then run the help command to see the available options:

dtt --help

Requirements

The minimum supported Rust toolchain version is currently Rust 1.69.0 or later (stable). It is recommended that you install the latest stable version of Rust.

Platform support

DateTime (DTT) is supported and tested on the following platforms:

Tier 1 platforms 🏆

Tier 2 platforms 🥈

The GitHub Actions shows the platforms in which the DateTime (DTT) library tests are run.

Documentation

ℹ️ Info: Please check out our website for more information. You can find our documentation on docs.rs, lib.rs and crates.io.

Usage 📖

To use the DateTime (DTT) library in your project, add the following to your Cargo.toml file:

[dependencies]
dtt = "0.0.5"

Add the following to your main.rs file:

extern crate dtt;
use dtt::*;

then you can use the functions in your application code.

Examples

To get started with DateTime (DTT), you can use the examples provided in the examples directory of the project.

To run the examples, clone the repository and run the following command in your terminal from the project root directory.

cargo run --example dtt

Example 1: Creating a new DateTime object

use dtt::DateTime;
use dtt::dtt_print;

fn main() {
    // Create a new DateTime object with the current UTC time
    let now = DateTime::new();
    dtt_print!(now);
}

Example 2: Creating a new DateTime object with a custom timezone

use dtt::DateTime;
use dtt::dtt_print;

fn main() {
    // Create a new DateTime object with a custom timezone (e.g., CEST)
    let paris_time = DateTime::new_with_tz("CEST");
    dtt_print!(paris_time);
}

Custom timezones supported by DateTime (DTT) are:

Example 3: Formatting a DateTime object

use dtt::DateTime;
use dtt::dtt_print;

fn main() {
    // Create a new DateTime object with the current UTC time
    let now = DateTime::new();

    // Format the DateTime object as a string
    let formatted_time = now.format("%Y-%m-%d %H:%M:%S");
    dtt_print!("Formatted time: {}", formatted_time);
}

Example 4: Parsing a string into a DateTime object

use dtt::DateTime;
use dtt::dtt_print;

fn main() {
    // Parse a string into a DateTime object
    let date_string = "2023-05-12T12:00:00+00:00";
    match DateTime::parse(date_string) {
        Ok(datetime) => dtt_print!("Parsed DateTime: {}", datetime),
        Err(err) => dtt_print!("Error parsing DateTime: {}", err),
    }
}

Semantic Versioning Policy 🚥

For transparency into our release cycle and in striving to maintain backward compatibility, DateTime (DTT) follows semantic versioning.

License 📝

The project is licensed under the terms of both the MIT license and the Apache License (Version 2.0).

• Apache License, Version 2.0
• MIT license

Contribution 🤝

We welcome all people who want to contribute. Please see the contributing instructions for more information.

Contributions in any form (issues, pull requests, etc.) to this project must adhere to the Rust's Code of Conduct.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Acknowledgements 💙

A big thank you to all the awesome contributors of the DateTime (DTT) Library for their help and support.

A special thank you goes to the Rust Reddit community for providing a lot of useful suggestions on how to improve this project.