Skip to content

DateTime (DTT) πŸ¦€ v0.0.2

Compare
Choose a tag to compare
@github-actions github-actions released this 10 Feb 20:04
eb2b392

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

Made With Love Crates.io Lib.rs Docs.rs License Codecov

divider

Welcome to DTT πŸ‘‹

DTT Banner

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 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 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 struct includes fields such as day, hour, iso_8601, iso_week, microsecond, minute, month, now, offset, ordinal, second, time, tz, weekday, and year, each of which represent different aspects of a date and time.

The DateTime struct has two methods to create instances: new and new_with_tz. new creates a new DateTime object with UTC timezone, and new_with_tz creates a new DateTime 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.

Installation πŸ“¦

It takes just a few minutes to get up and running with dtt.

Requirements

dtt requires Rust 1.67.0 or later.

Documentation

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

Usage πŸ“–

To use dtt in your project, add the following to your Cargo.toml file:

[dependencies]
dtt = "0.0.2"

Add the following to your main.rs file:

extern crate dtt;
use dtt::*;

then you can use the functions in your application code.

Examples

DTT comes with a set of examples that you can use to get started. The examples are located 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

Semantic Versioning Policy πŸš₯

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

License πŸ“

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

Contribution 🀝

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.

divider

Acknowledgements πŸ’™

A big thank you to all the awesome contributors of Mini Functions 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.