envpath 0.0.1

A library for parsing and deserialising paths with special rules. The format is similar to `["$proj(com.xy.z): data ? cfg", "$const: os", "$val: rand-16"]`
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

use rand::{Rng, distr::Alphanumeric};

/// Generates a random string of alphanumeric characters using the `rand` crate.
///
/// It takes an optional parameter `rand_length` to specify the length of the
/// random string, defaulting to 16 characters if not provided. The function
/// first imports necessary modules from the `rand` crate and then uses the
/// current thread to generate a random number generator. It then samples
/// characters from the alphanumeric distribution, maps them into a String, and
/// collects them into a single String to return as output.
///
/// # Examples
///
/// ```
/// let val = envpath::random::get_random_value(Some(32));
/// dbg!(&val);
/// ```
pub fn get_random_value(rand_length: Option<usize>) -> String {
  rand::rng() // Generate a random number generator using the current thread.
    .sample_iter(&Alphanumeric) // Sample characters from the alphanumeric distribution.
    .take(rand_length.unwrap_or(16)) // Take either the provided length or default to 16 characters.
    .map(char::from) // Map the characters into a String.
    .collect() // Collect the mapped characters into a single String.
}
#[cfg(test)]
mod tests {

  #[test]
  fn random_value() {
    let val = crate::random::get_random_value(Some(3));
    dbg!(val);
  }
}