small readme

tokio-1.0
Avril 4 years ago
parent f6be53890f
commit 932ba3bfeb
Signed by: flanchan
GPG Key ID: 284488987C31F630

@ -1,6 +1,8 @@
[package] [package]
name = "cryptohelpers" name = "cryptohelpers"
version = "0.1.0" version = "0.1.0"
license= "mit"
description = "Collection of helpers and simplifying functions for cryptography things"
authors = ["Avril <flanchan@cumallover.me>"] authors = ["Avril <flanchan@cumallover.me>"]
edition = "2018" edition = "2018"

@ -0,0 +1,18 @@
# cryptohelpers
Collection of helpers and simplifying functions for cryptography things.
All modules are feature gated.
* sha256 - `sha256` feature
* password - `password` feature
* aes - `aes` feature
* crc - `checksum` feature
* rsa - `rsa` feature
There is also `full` for enabling them all.
## Async processing
The `async` feature adds asynchronous streaming functions with Tokio's `AsyncRead` and `AsyncWrite` traits.
# License
MIT

@ -1,11 +1,25 @@
//! Collection of helpers for cryptography things.
//! All modules are feature gated.
//!
//! * sha256 - `sha256` feature
//! * password - `password` feature
//! * aes - `aes` feature
//! * crc - `checksum` feature
//! * rsa - `rsa` feature
//!
//! There is also `full` for enabling them all.
//!
//! # Async processing
//! The `async` feature adds asynchronous streaming functions with Tokio's `AsyncRead` and `AsyncWrite` traits.
#![allow(dead_code)] #![allow(dead_code)]
pub mod consts; pub mod consts;
#[allow(unused_imports)] #[allow(unused_imports)]
use consts::*; use consts::*;
pub mod util; mod util;
pub mod bytes; mod bytes;
#[allow(unused_imports)] #[allow(unused_imports)]
mod error; mod error;
@ -20,6 +34,5 @@ pub mod password;
pub mod aes; pub mod aes;
#[cfg(feature="checksum")] #[cfg(feature="checksum")]
pub mod crc; pub mod crc;
#[cfg(feature="rsa")] #[cfg(feature="rsa")]
pub mod rsa; pub mod rsa;

Loading…
Cancel
Save