Rut Library 🇨🇱

A Rust library for parsing, format and validate a Chilean ID (RUT)

Usage

This crate is on crates.io and can be used by adding rut_lib to your dependencies in your project's Cargo.toml.

toml [dependencies] rut_lib = "0.10.0"

Then you'll also need to add it to your crate root:

rust extern crate rut_lib;

Example: Parsing from String

A easy way to validate and create a Rut using the from method, this returns a Result<Rut, Error>

The input must be a valid String format, a few examples: - 17.951.585-7 - 17951585-7 - 179515857

```rust use rut_lib::Rut;

fn main() { let stringifier_rut = "17951585-7";

match Rut::from(stringifier_rut) {
    Ok(rut) => {
        println!("Number: {:#}", rut.number());
        println!("DV: {:#}", rut.dv());
        println!("RUT: {:#}", rut)
    },
    Err(error) => println!("Error: {:#}", error)
}

} ``` Output

bash Number: 17951585 DV: 7 RUT: 17951585-7

Error behaviour

Error::InvalidFormat

```rust use rut_lib::Rut; fn main() { let stringifier_rut = "17,951,585-7"; match Rut::from(stringifier_rut) { Ok(rut) => println!("RUT: {:#}", rut), Err(error) => println!("Error: {:#}", error) } } ``` Output ```bash Error: The input format is invalid ```

Error::InvalidDV

```rust use rut_lib::Rut; fn main() { let stringifier_rut = "17951585K"; match Rut::from(stringifier_rut) { Ok(rut) => println!("RUT: {:#}", rut), Err(error) => println!("Error: {:#}", error) } } ``` Output ```bash Error: Invalid DV, must be 7, instead K. ```

Example: Parsing from Number

Create a Rut using the from_number method (If you don't have a DV), this returns a Result<Rut, Error>

The input must be a number (u32) and stay in a range from 1_000_000 to 99_999_999

```rust use rut_lib::Rut;

fn main() { let number = 24136773; match Rut::from_number(number) { Ok(rut) => { println!("Number: {:#}", rut.number()); println!("DV: {:#}", rut.dv()); println!("RUT: {:#}", rut) }, Err(error) => println!("Error: {:#}", error) } } ```

Output

bash Number: 24136773 DV: 8 RUT: 24136773-8

Error behaviour

Error::OutOfRange

```rust use rut_lib::Rut; fn main() { let number = 999_999; match Rut::from_number(number) { Ok(rut) => { println!("RUT: {:#}", rut) }, Err(error) => println!("Error: {:#}", error) } } ``` Output ```bash Error: The input number must be between 1.000.000 to 99.999.999 ```

Example: Randomize Rut

Generate a randomize rut from scratch for testing use

Example: ```rust use rut_lib::Rut;

fn main() { let rut = Rut::randomize(); println!("Number: {:#}", rut.number()); println!("DV: {:#}", rut.dv()); println!("RUT: {:#}", rut) } ```

Output

bash Number: 56606059 DV: 0 RUT: 56606059-0

Example: Prettify Rut

The to_format method receive a Format as input to returns a Prettify Rut, you need to use the rut_lib::Format (enum)

```rust use rut_lib::{Rut, Format};

fn main() { let input = "179515857"; let rut = Rut::from(input).unwrap();

    println!("Dots: {}", rut.to_format(DOTS));
    println!("Dash: {}", rut.to_format(DASH));
    println!("None: {}", rut.to_format(NONE))

} ```

Output

bash Dots: 17.951.585-7 Dash: 17951585-7 None: 179515857

License

This project is licensed under the terms of the MIT License.