pgident 0.0.3

A library for escaping and quoting Postgres identifiers/names
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

use crate::IdentError;
use std::fmt::{Display, Formatter};

use crate::util::is_ident_compatible;

#[derive(Debug)]
pub enum PgIdent<T> where T: AsRef<str> {
    Id(T),
    Quoted(String)
}

impl<T: AsRef<str>> PgIdent<T> {
    pub fn new(id: T) -> Result<Self, IdentError> {
        if is_ident_compatible(id.as_ref()) {
            Ok(Self::Id(id))
        } else {
            let id = id.as_ref();
            if id.contains('\x00') {
                return Err(IdentError::NullByteError{});
            }
            Ok(Self::Quoted(id.replace("\"", "\"\"")))
        }
    }
}

impl<T> Display for PgIdent<T> where T: AsRef<str> {
    fn fmt(&self, f: &mut Formatter) -> core::fmt::Result {
        match self {
            Self::Id(id) => write!(f, "{}", id.as_ref()),
            Self::Quoted(id) => write!(f, "\"{}\"", id),
        }
    }
}

impl TryFrom<&str> for PgIdent<String> {
    type Error = IdentError;

    fn try_from(value: &str) -> Result<Self, Self::Error> {
        PgIdent::new(value.to_string())
    }
}

impl<T> Clone for PgIdent<T> where T: AsRef<str> + Clone {
    fn clone(&self) -> Self {
        match self {
            Self::Id(id) => Self::Id(id.clone()),
            Self::Quoted(id) => Self::Quoted(id.clone()),
        }
    }
}


#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn from_str() {
        let id: PgIdent<String> = "foo".try_into().unwrap();
        assert_eq!(format!("{}", id), "foo");
    }

    #[test]
    fn simple() {
        let id = PgIdent::new("foo").unwrap();
        assert_eq!(format!("{}", id), "foo");
    }

    #[test]
    fn quoted() {
        let id = PgIdent::new("FOO").unwrap();
        assert!(matches!(id, PgIdent::Quoted(_)));
        assert_eq!(format!("{}", id), "\"FOO\"");
    }

    #[test]
    fn quoted_escaped() {
        let id = PgIdent::new("The \"table\"").unwrap();
        assert!(matches!(id, PgIdent::Quoted(_)));
        assert_eq!(format!("{}", id), "\"The \"\"table\"\"\"");
    }

}