# Random password generator




## What

This is a crate about generate random passwords.


## Why

To learn Rust.


## Requirement

Rust 1.39 or higher.


## Try it

```shell script
$ git clone https://github.com/TENX-S/rand_pwd
$ cd rand_pwd

# Default case: amount of letters: 10, symbols: 2, numbers: 3
$ cargo run --release --example rpg_test

# Specify the parameter: amount of letters: 16, symbols: 2, numbers: 3
$ cargo run --release --example rpg_test 16 2 3

# Try a larger number!
$ cargo run --release --example rpg_test 200000 200 300
```


## ATTENTION!

**Do not** try a very large number, even it's programly allowed, like `i128::MAX`, 
unless you got extremely large RAM and great CPU, 
or you may got a **blue screen or any unpredictable behaviours** that will harm your computer hardware or unsaved files since you don't [set a right `UNIT` number](https://docs.rs/rand_pwd/1.0.3/rand_pwd/).

**UNDER ANY CIRCUMSTANCES YOU USE THIS CRATE AND THE RESULT IT CAUSED, NO ONE WILL BE RESPONIBLE FOR YOU BEHAVIOURS.**

## Usage

In `Cargo.toml`:
```toml
rand_pwd = "1"
```

You may want to use the latest feature(not stable and may requires nightly Rust):
```toml
rand_pwd = { git = "https://github.com/TENX-S/rand_pwd", branch = "master" }
```

Here's the simply demo of partital API:
```rust
use rand_pwd::{ RandPwd, ToRandPwd };

fn main() {

    let mut r_p = RandPwd::new(10, 2, 3); // For now, it's empty. Use method `join` to generate the password
    r_p.join();                           // Now `r_p` has some content, be kept in its `content` field
    println!("{}", r_p);                  // Print it on the screen
    // One possible output: 7$pA7yMCw=2DPGN

    // Or you can build from an existing `&str`
    let mut r_p = RandPwd::from("=tE)n5f`sidR>BV"); // 10 letters, 4 symbols, 1 number 
    // You can rebuild a random password and with equivalent amount of letters, symbols and numbers. Like below
    r_p.join();
    println!("{}", r_p); 
    // One possible output: qS`Xlyhpmg~"V8[
    
    // All the `String` and `&str` has implemented trait `ToRandPwd`
    // which means you can use method `to_randpwd` to convert a `String` or `&str` to `RandPwd`
    
    let mut r_p = "n4jpstv$dI,.z'K".to_randpwd().unwrap();

    // Panic! Has non-ASCII character(s)!
    // let mut r_p = RandPwd::from("🦀️🦀️🦀️"); 
    // let mut r_p = "🦀️🦀️🦀️".to_randpwd(); 
}   
```


## Contribution
Any PR is welcome!

## LICENSE
MIT
