Common (CMN)

A Rust library for accessing a collection of mathematical and cryptographic constants

Part of the Mini Functions family of libraries.

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

Overview 📖

Common (CMN) is a modern, fast, and user-friendly library that makes it easy to access a wide range of mathematical and cryptographic constants.

Features ✨

The Common (CMN) uses the serde crate to serialize and deserialize the data.

The library has three modules:

• Macros: This module contains functions for generating macros that can be used to access the constants.
• Constants: This module contains the Constants structure, which provides a collection of constant values that are used throughout the library.
• Words: This module contains the Words structure, which provides a collection of words that are used throughout the library.

Mathematical and Cryptographic Constants

The following table lists the most important mathematical and cryptographic constants available in the Common (CMN) library:

Getting Started 🚀

It takes just a few minutes to get up and running with Common (CMN).

Installation

To install Common (CMN), 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 Common (CMN) using the following command:

cargo install cmn

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

cmn --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

Common (CMN) is supported and tested on the following platforms:

Tier 1 platforms 🏆

Tier 2 platforms 🥈

The GitHub Actions shows the platforms in which the Common (CMN) 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 Common (CMN) library in your project, add the following to your Cargo.toml file:

[dependencies]
cmn = "0.0.3"

Add the following to your main.rs file:

extern crate cmn;
use cmn::*;

then you can use the functions in your application code.

Examples

Common (CMN) 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 cmn

Semantic Versioning Policy 🚥

For transparency into our release cycle and in striving to maintain backward compatibility, Common (CMN) 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 Common (CMN) 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.