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

use serde;
use std;

use DesignDocumentName;

/// Name of a document.
/// 
/// A document name wraps a string specifying a document—e.g., the `doc` part of
/// the HTTP request to GET `http://example.com:5984/db/doc` or the `design-doc`
/// part of the HTTP request to GET
/// `http://example.com:5984/db/_design/design-doc`.
///
/// Document names may be converted to and from strings. They are never
/// percent-encoded.
///
/// Although the `DocumentName` type implements the `Ord` and `PartialOrd`
/// traits, it provides no guarantees how that ordering is defined and may
/// change the definition between any two releases of the couchdb crate. That
/// is, for two `DocumentName` values `a` and `b`, the expression `a < b` may
/// hold true now but not in a subsequent release. Consequently, applications
/// must not rely upon any particular ordering definition.
///
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct DocumentName(String);
impl_name_type!(DocumentName);

impl DocumentName {
    /// Constructs an empty document name.
    pub fn new() -> Self {
        DocumentName(String::new())
    }
}

impl From<DesignDocumentName> for DocumentName {
    fn from(ddoc_name: DesignDocumentName) -> Self {
        let s = String::from(ddoc_name);
        DocumentName::from(s)
    }
}

#[cfg(test)]
mod tests {

    use serde_json;

    use DesignDocumentName;
    use DocumentName;

    #[test]
    fn document_name_display() {
        let expected = "foo";
        let got = format!("{}", DocumentName::from("foo"));
        assert_eq!(expected, got);
    }

    #[test]
    fn document_name_as_ref_str() {
        let expected = "foo";
        let d = DocumentName::from("foo");
        let got: &str = d.as_ref();
        assert_eq!(expected, got);
    }

    #[test]
    fn document_name_as_ref_string() {
        let expected = "foo".to_string();
        let d = DocumentName::from("foo");
        let got = d.as_ref();
        assert_eq!(expected, got);
    }

    #[test]
    fn document_name_from_str_ref() {
        let expected = DocumentName("foo".to_string());
        let got = DocumentName::from("foo");
        assert_eq!(expected, got);
    }

    #[test]
    fn document_name_from_string() {
        let expected = DocumentName("foo".to_string());
        let got = DocumentName::from("foo".to_string());
        assert_eq!(expected, got);
    }

    #[test]
    fn document_name_from_design_document_name() {
        let expected = DocumentName("foo".to_string());
        let got = DocumentName::from(DesignDocumentName::from("foo"));
        assert_eq!(expected, got);
    }

    #[test]
    fn string_from_document_name() {
        let expected = "foo".to_string();
        let got = String::from(DocumentName::from("foo"));
        assert_eq!(expected, got);
    }

    #[test]
    fn document_name_serialization() {
        let expected = serde_json::Value::String("foo".to_string());
        let source = DocumentName::from("foo");
        let s = serde_json::to_string(&source).unwrap();
        let got = serde_json::from_str(&s).unwrap();
        assert_eq!(expected, got);
    }

    #[test]
    fn document_name_deserialization() {
        let expected = DocumentName::from("foo");
        let source = serde_json::Value::String("foo".to_string());
        let s = serde_json::to_string(&source).unwrap();
        let got = serde_json::from_str(&s).unwrap();
        assert_eq!(expected, got);
    }

    #[test]
    fn document_name_new() {
        let expected = DocumentName::from(String::new());
        let got = DocumentName::new();
        assert_eq!(expected, got);
    }
}