cnsl 0.1.3

A crate that provides methods and macros for interacting with the command line.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

# cnsl

`cnsl` is a crate for writing to the standard output, standard error, and reading from standard input.\
This crate is lightly coded, and also requires no external dependencies.

![Rust Build Status](https://github.com/ImajinDevon/cnsl/actions/workflows/rust.yml/badge.svg)

---

# Usage

## readln macro

---
```rust
// without a prompt
```
```rust
use cnsl::readln;

fn main() {
    println!("What is your name?");
    let name = readln!();
    println!("Hello, {}!", name);
}
```
---
```rust
// with a prompt
```
```rust
use cnsl::readln;

fn main() {
    let name = readln!("Enter your name: ");
    println!("Hello, {}!", name);
}
```
---
```rust
// with a formatted prompt
// note: defaults are not actually supported, this is just a demonstration
```
```rust
use cnsl::readln;

const DEFAULT_AGE: u8 = 18;

fn main() {
    let age_input = readln!("Enter your age (default {}): ", DEFAULT_AGE);
    
    let age = if age_input.is_empty() {
        DEFAULT_AGE
    } else {
        age_input.parse::<u8>().expect("invalid input for age")
    };
}
```

# Information

## License

This software is licensed under the [WTFPL](https://www.wtfpl.net/).

## Contributors

- [ImajinDevon](https://www.github.com/imajindevon/)

---
<footer>© 2022 WTFPL – Do What the Fuck You Want to Public License.</footer>