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
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166

mod path;

use std::borrow::Borrow;
use std::fmt::{self, Display, Formatter};
use std::ops::Deref;
use std::str::FromStr;

use serde::de::{self, Deserialize, Deserializer, Visitor};
use serde::ser::{Serialize, Serializer};

use error::Error;

pub use self::path::Path;

/// An immutable wrapper around [`String`] that enforces compliance
/// with JSON API [Member Names].
///
/// [`String`]: https://doc.rust-lang.org/std/string/struct.String.html
/// [Member Names]: http://jsonapi.org/format/#document-member-names
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct Key(String);

impl AsRef<[u8]> for Key {
    fn as_ref(&self) -> &[u8] {
        self.as_bytes()
    }
}

impl AsRef<str> for Key {
    fn as_ref(&self) -> &str {
        &**self
    }
}

impl Borrow<str> for Key {
    fn borrow(&self) -> &str {
        &**self
    }
}

impl Deref for Key {
    type Target = str;

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

impl Display for Key {
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
        Display::fmt(&**self, f)
    }
}

impl From<Key> for String {
    fn from(key: Key) -> Self {
        let Key(value) = key;
        value
    }
}

impl FromStr for Key {
    type Err = Error;

    fn from_str(value: &str) -> Result<Key, Self::Err> {
        if value.is_empty() {
            bail!("Member names cannot be blank");
        }

        let last = value.len() - 1;
        for (idx, chr) in value.chars().enumerate() {
            match chr {
                '\u{002b}' |
                '\u{002c}' |
                '\u{002e}' |
                '\u{005b}' |
                '\u{005d}' |
                '\u{0021}' |
                '\u{0022}' |
                '\u{0023}' |
                '\u{0024}' |
                '\u{0025}' |
                '\u{0026}' |
                '\u{0027}' |
                '\u{0028}' |
                '\u{0029}' |
                '\u{002a}' |
                '\u{002f}' |
                '\u{003a}' |
                '\u{003b}' |
                '\u{003c}' |
                '\u{003d}' |
                '\u{003e}' |
                '\u{003f}' |
                '\u{0040}' |
                '\u{005c}' |
                '\u{005e}' |
                '\u{0060}' |
                '\u{007b}' |
                '\u{007c}' |
                '\u{007d}' |
                '\u{007e}' |
                '\u{007f}' |
                '\u{0000}'...'\u{001f}' => {
                    bail!("Member names cannot contain {}", chr);
                }
                '\u{002d}' | '\u{005f}' | '\u{0020}' if idx == 0 => {
                    bail!("Member names cannot start with {}", chr);
                }
                '\u{002d}' | '\u{005f}' | '\u{0020}' if idx == last => {
                    bail!("Member names cannot end with {}", chr);
                }
                _ => (),
            }
        }

        Ok(Key(value.to_owned()))
    }
}

impl PartialEq<String> for Key {
    fn eq(&self, rhs: &String) -> bool {
        &self.0 == rhs
    }
}

impl PartialEq<str> for Key {
    fn eq(&self, rhs: &str) -> bool {
        &**self == rhs
    }
}

impl<'de> Deserialize<'de> for Key {
    fn deserialize<D>(deserializer: D) -> Result<Key, D::Error>
    where
        D: Deserializer<'de>,
    {
        struct KeyVisitor;

        impl<'de> Visitor<'de> for KeyVisitor {
            type Value = Key;

            fn expecting(&self, f: &mut Formatter) -> fmt::Result {
                f.write_str("a valid json api member name")
            }

            fn visit_str<E>(self, value: &str) -> Result<Self::Value, E>
            where
                E: de::Error,
            {
                value.parse().map_err(de::Error::custom)
            }
        }

        deserializer.deserialize_str(KeyVisitor)
    }
}

impl Serialize for Key {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_str(self)
    }
}