link_rs 0.1.0

Generate hash-id based URLs and QR codes for use in URL shortening services.
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

<div align="center">

  <h1><code>link-rs</code></h1>

  <strong>Generate hash-id based URLs and QR codes for use in URL shortening services.</strong>

</div>

## About

A simple implementation of a URL generation module. Allows for qr-code generation using the [`qrcode`](https://crates.io/crates/qrcode) library.

## 🔋 Usage

Basic Example:

```rs
mod link_rs::LinkGenerator


fn main() {
    let mut link_gen = LinkGenerator::new("/some/redirect", 10);

    let link = link_gen::generate_url()
    println!("{:?}", link) // Link { key: "vq5ejng0p6", url: "/some/redirect/vq5ejng0p6" }
}

```

To see a complete implementation of a url shortening service, please take a look at the [`actix-web`](https://github.com/OliverBrotchie/link-rs/blob/main/examples/actix.rs) example.

### 🛠️ Add via `cargo.toml`

```toml
link_rs = { version = "0.1.0", features = ["qrcode"] }
```

### 🔬 Test using `cargo test`

```sh
cargo test --features qrcode
```