cbor-core 0.9.2

CBOR::Core deterministic encoder/decoder with owned data structures
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

use std::borrow::Cow;

use crate::Value;

/// Conversion helper for [`Value::text_string`].
///
/// Wraps a `Cow<'a, str>` so that [`Value::text_string`] can accept
/// owned and borrowed string inputs through a single
/// `impl Into<TextString>` bound. This mirrors how [`Array`](crate::Array)
/// and [`Map`](crate::Map) abstract their input shapes.
///
/// Supported source types:
///
/// - `&'a str` (and any `&'a T` with `T: AsRef<str>`) borrows zero-copy.
/// - Owned `String` is moved without copying.
/// - `Cow<'a, str>` is preserved as-is.
/// - `char` allocates a one-character `String`.
///
/// ```
/// # use cbor_core::Value;
/// // Borrows from the literal:
/// let v = Value::text_string("hello");
/// assert_eq!(v.as_str().unwrap(), "hello");
///
/// // Owns its storage:
/// let v = Value::text_string(String::from("hello"));
/// assert_eq!(v.as_str().unwrap(), "hello");
/// ```
#[derive(Debug, Default, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct TextString<'a>(Cow<'a, str>);

impl TextString<'_> {
    /// Create an empty text string.
    ///
    /// The result is `Cow::Borrowed("")` and lives for any lifetime.
    #[must_use]
    pub const fn new() -> Self {
        Self(Cow::Borrowed(""))
    }

    /// Borrow the contents as a `&str`.
    #[must_use]
    pub fn as_str(&self) -> &str {
        self.0.as_ref()
    }

    /// Borrow the contents as a mutable `String`, cloning if the
    /// inner `Cow` is currently borrowed.
    pub fn as_string_mut(&mut self) -> &mut String {
        self.0.to_mut()
    }

    /// Detach from any borrow, returning a `TextString` with an
    /// independent lifetime.
    ///
    /// A borrowed `TextString<'a>` is copied into an owned `String`;
    /// an already-owned one is returned unchanged. The result can
    /// be assigned to any lifetime, in particular `TextString<'static>`.
    #[must_use]
    pub fn into_owned<'b>(self) -> TextString<'b> {
        match self.0 {
            Cow::Borrowed(text) => TextString(text.to_string().into()),
            Cow::Owned(text) => TextString(text.into()),
        }
    }
}

impl From<char> for TextString<'_> {
    fn from(value: char) -> Self {
        Self(value.to_string().into())
    }
}

impl<'a, T> From<&'a T> for TextString<'a>
where
    T: AsRef<str> + ?Sized,
{
    fn from(value: &'a T) -> Self {
        Self(value.as_ref().into())
    }
}

impl From<String> for TextString<'_> {
    fn from(value: String) -> Self {
        Self(value.into())
    }
}

impl<'a> From<Cow<'a, str>> for TextString<'a> {
    fn from(value: Cow<'a, str>) -> Self {
        Self(value)
    }
}

impl<'a> From<TextString<'a>> for Value<'a> {
    fn from(value: TextString<'a>) -> Self {
        Self::TextString(value.0)
    }
}

/// Borrows the text rather than copying it.
impl<'a> From<&'a TextString<'a>> for Value<'a> {
    fn from(value: &'a TextString<'a>) -> Self {
        Self::TextString(Cow::Borrowed(value.as_str()))
    }
}