package-key 0.2.0

A case-insensitive, normalized string, suitable as a package name.
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

use std::ops::Deref;

use crate::InsensitiveKey;

impl Default for InsensitiveKey {
    fn default() -> Self {
        InsensitiveKey::new("")
    }
}

impl Deref for InsensitiveKey {
    type Target = str;

    fn deref(&self) -> &Self::Target {
        &self.key
    }
}

impl InsensitiveKey {
    /// Create a new key
    ///
    /// # Examples
    ///
    /// ```
    /// # use package_key::InsensitiveKey;
    /// let key = InsensitiveKey::new("package-name");
    /// ```
    pub fn new<S>(key: S) -> Self
    where
        S: AsRef<str>,
    {
        Self { key: norm_key(key.as_ref()) }
    }
    /// Make the key like a [&str](std::str).
    ///
    /// # Examples
    ///
    /// ```
    /// # use package_key::InsensitiveKey;
    /// let key = InsensitiveKey::new("package-name");
    /// ```
    pub fn as_str(&self) -> &str {
        &self.key
    }
}

fn norm_key(s: &str) -> String {
    let mut out = String::with_capacity(s.len());
    for c in s.chars() {
        match c {
            '_' | '-' => out.push('_'),
            s if s.is_ascii_whitespace() => out.push('_'),
            _ => out.push(c.to_ascii_uppercase()),
        }
    }
    out
}