randoid 0.3.0

Implementation of nanoid ids that doesn't requre allocation
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

#![cfg(feature = "std-rand")]
use super::Generator;

use super::DEFAULT_SIZE;
use crate::alphabet::{Alphabet, DEFAULT};
use rand::{rngs::ThreadRng, thread_rng};

impl<'a, const N: usize> Generator<'a, ThreadRng, N> {
    /// Create a new randoid generator using a specific alphabet
    ///
    /// And using the default size and [`rand::thread_rng()`] as the RNG.
    pub fn with_alphabet(alphabet: &'a Alphabet<N>) -> Self {
        Self::new(DEFAULT_SIZE, alphabet, thread_rng())
    }
}

impl<'a> Generator<'a, ThreadRng> {
    /// Create a new randoid generator that generates ids of a specific size
    ///
    /// But use the default alphabet and [`rand::thread_rng()`] as the RNG.
    pub fn with_size(size: usize) -> Self {
        Self {
            alphabet: &DEFAULT,
            random: thread_rng(),
            size,
        }
    }
}

impl Default for Generator<'static, rand::rngs::ThreadRng> {
    fn default() -> Self {
        Self {
            alphabet: &DEFAULT,
            random: thread_rng(),
            size: DEFAULT_SIZE,
        }
    }
}

/// Simple API for generating a nano id
///
/// This creates a `String` containing a randomly generated id using the default size (21),
/// alphabet (url safe with 64 characters), and Rng (`rand::thread_rng()`).
///
/// # Example:
///
/// ```
/// use randoid::randoid;
///
/// let id = randoid();
///
/// assert_eq!(id.len(), 21);
/// for c in id.chars() {
///     assert!(c.is_alphanumeric() || c == '-' || c == '_');
/// }
/// ```
#[inline]
pub fn randoid() -> String {
    Generator::default().gen()
}