ion-rs 1.0.0

Implementation of Amazon Ion
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
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

use crate::ion_data::{IonDataHash, IonDataOrd, IonEq};
use crate::text::text_formatter::FmtValueFormatter;
use std::cmp::Ordering;
use std::fmt::{Display, Formatter};
use std::hash::{Hash, Hasher};

/// An owned, immutable in-memory representation of an Ion `string`.
///
/// ```
/// use ion_rs::Str;
/// let s: Str = "hello!".into();
/// assert_eq!(s, "hello!");
/// ```
#[derive(Eq, Ord, PartialOrd, Debug, Clone, Hash)]
pub struct Str {
    // For the time being, the `Str` type is an opaque wrapper around the standard Rust `String`
    // type. Having this opaque wrapper means that we can swap out its implementation without a
    // breaking change, allowing us to offer string interning, stack-allocated small strings, or
    // other optimizations as needed.
    text: String,
}

impl Str {
    /// Returns the number of UTF-8 encoded bytes in this string.
    ///
    /// ```
    /// use ion_rs::Str;
    /// let s: Str = "hello!".into();
    /// assert_eq!(s.len(), 6);
    /// // Note that the length returned is a number of UTF-8 bytes, not codepoints or graphemes.
    /// let s: Str = "🚀🚀🚀".into();
    /// assert_eq!(s.len(), 12);
    /// ```
    pub fn len(&self) -> usize {
        self.text.len()
    }

    /// Returns `true` if this is the empty string (`""`); otherwise, returns `false`.
    ///
    /// ```
    /// use ion_rs::Str;
    /// let s: Str = "".into();
    /// assert!(s.is_empty());
    /// let s: Str = "hello!".into();
    /// assert!(!s.is_empty());
    /// ```
    // This method is largely here because clippy complains if you provide a `len()` method but not
    // an accompanying `is_empty()` method.
    pub fn is_empty(&self) -> bool {
        self.text.is_empty()
    }

    /// Returns a `&str` representation of this string's text.
    ///
    /// ```
    /// use ion_rs::Str;
    /// let s: Str = "hello, world!".into();
    /// assert!(s.text().contains("world"));
    /// assert!(s.text().is_ascii());
    /// ```
    pub fn text(&self) -> &str {
        self.text.as_str()
    }
}

impl Display for Str {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        let mut formatter = FmtValueFormatter { output: f };
        formatter
            .format_string(self.as_ref())
            .map_err(|_| std::fmt::Error)
    }
}

impl From<&str> for Str {
    fn from(value: &str) -> Self {
        Str {
            text: value.to_string(),
        }
    }
}

impl From<String> for Str {
    fn from(value: String) -> Self {
        Str { text: value }
    }
}

impl From<Str> for String {
    fn from(value: Str) -> Self {
        value.text
    }
}

impl AsRef<str> for Str {
    fn as_ref(&self) -> &str {
        self.text()
    }
}

impl<S> PartialEq<S> for Str
where
    S: AsRef<str>,
{
    fn eq(&self, other: &S) -> bool {
        let other_text: &str = other.as_ref();
        self.text() == other_text
    }
}

impl PartialEq<Str> for &str {
    fn eq(&self, other: &Str) -> bool {
        self.eq(&other.text())
    }
}

impl PartialEq<Str> for String {
    fn eq(&self, other: &Str) -> bool {
        let self_text: &str = self.as_str();
        self_text.eq(other.text())
    }
}

impl IonEq for Str {
    fn ion_eq(&self, other: &Self) -> bool {
        self == other
    }
}

impl IonDataOrd for Str {
    fn ion_cmp(&self, other: &Self) -> Ordering {
        self.cmp(other)
    }
}

impl IonDataHash for Str {
    fn ion_data_hash<H: Hasher>(&self, state: &mut H) {
        self.hash(state)
    }
}