bstr 0.1.0

A string type that is not required to be valid UTF-8.
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

#[cfg(feature = "std")]
use std::borrow::Cow;
use core::ops;

use bstr::BStr;
#[cfg(feature = "std")]
use bstring::BString;

/// A specialized copy-on-write BStr.
///
/// The purpose of this type is to permit usage of a "borrowed or owned byte
/// string" in a way that keeps std/no-std compatibility. That is, in no-std
/// mode, this type devolves into a simple &BStr with no owned variant
/// availble.
#[derive(Clone, Debug)]
pub struct CowBStr<'a>(Imp<'a>);

#[cfg(feature = "std")]
#[derive(Clone, Debug)]
struct Imp<'a>(Cow<'a, BStr>);

#[cfg(not(feature = "std"))]
#[derive(Clone, Debug)]
struct Imp<'a>(&'a BStr);

impl<'a> ops::Deref for CowBStr<'a> {
    type Target = BStr;

    fn deref(&self) -> &BStr {
        self.as_bstr()
    }
}

impl<'a> CowBStr<'a> {
    /// Create a new borrowed CowBStr.
    pub fn new<B: ?Sized + AsRef<[u8]>>(bytes: &'a B) -> CowBStr<'a> {
        CowBStr(Imp::new(BStr::new(bytes)))
    }

    /// Create a new owned CowBStr.
    #[cfg(feature = "std")]
    pub fn new_owned(bytes: BString) -> CowBStr<'static> {
        CowBStr(Imp(Cow::Owned(bytes)))
    }

    /// Return a borrowed byte string, regardless of whether this is an owned
    /// or borrowed byte string internally.
    pub fn as_bstr(&self) -> &BStr {
        self.0.as_bstr()
    }

    /// Return an owned version of this copy-on-write byte string.
    ///
    /// If this is already an owned byte string internally, then this is a
    /// no-op. Otherwise, the internal byte string is copied.
    #[cfg(feature = "std")]
    pub fn into_owned(self) -> CowBStr<'static> {
        match (self.0).0 {
            Cow::Borrowed(b) => CowBStr::new_owned(b.to_bstring()),
            Cow::Owned(b) => CowBStr::new_owned(b),
        }
    }
}

impl<'a> Imp<'a> {
    #[cfg(feature = "std")]
    pub fn new(bytes: &'a BStr) -> Imp<'a> {
        Imp(Cow::Borrowed(bytes))
    }

    #[cfg(not(feature = "std"))]
    pub fn new(bytes: &'a BStr) -> Imp<'a> {
        Imp(bytes)
    }

    #[cfg(feature = "std")]
    pub fn as_bstr(&self) -> &BStr {
        // &*self.0
        match self.0 {
            Cow::Owned(ref x) => x,
            Cow::Borrowed(x) => x,
        }
    }

    #[cfg(not(feature = "std"))]
    pub fn as_bstr(&self) -> &BStr {
        self.0
    }
}