abin 0.1.6

A library for working with binaries and strings. The library tries to avoid heap-allocations / memory-copy whenever possible by automatically choosing a reasonable strategy: stack for small binaries; static-lifetime-binary or reference-counting.
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197

use core::fmt;
use std::borrow::Borrow;
use std::fmt::{Display, Formatter};
use std::hash::{Hash, Hasher};
use std::ops::Deref;

use crate::BooToOwned;

/// A borrowed-or-owned type (boo).
///
/// Similar to `std::borrow::Cow` but without the requirement of
/// `TBorrowed : ToOwned<Owned=TOwned>`.
#[derive(Debug)]
pub enum Boo<'a, TBorrowed, TOwned>
where
    TBorrowed: ?Sized,
{
    /// It's borrowed.
    Borrowed(&'a TBorrowed),
    /// It's owned.
    Owned(TOwned),
}

impl<'a, TBorrowed, TOwned> From<&'a TBorrowed> for Boo<'a, TBorrowed, TOwned>
where
    TBorrowed: ?Sized,
{
    fn from(borrowed: &'a TBorrowed) -> Self {
        Self::Borrowed(borrowed)
    }
}

/// Can convert `&T` to `Boo::Borrowed` and `T` to `Boo:Owned`.
pub trait ToBooConverter {
    /// Convert `&self` to `Boo::Borrowed`.
    fn borrowed<TBorrowed>(&self) -> Boo<TBorrowed, Self>
    where
        TBorrowed: ?Sized,
        Self: Borrow<TBorrowed>,
        Self: Sized;

    /// Convert `self` into `Boo::Owned`.
    fn owned<'a, TBorrowed>(self) -> Boo<'a, TBorrowed, Self>
    where
        TBorrowed: ?Sized,
        Self: Sized;
}

impl<T> ToBooConverter for T {
    fn borrowed<TBorrowed>(&self) -> Boo<TBorrowed, Self>
    where
        TBorrowed: ?Sized,
        Self: Borrow<TBorrowed>,
        Self: Sized,
    {
        Boo::Borrowed(self.borrow())
    }

    fn owned<'a, TBorrowed>(self) -> Boo<'a, TBorrowed, Self>
    where
        TBorrowed: ?Sized,
        Self: Sized,
    {
        Boo::Owned(self)
    }
}

impl<'a, TBorrowed, TOwned> Boo<'a, TBorrowed, TOwned>
where
    TOwned: Borrow<TBorrowed>,
    TBorrowed: ?Sized,
{
    /// Returns `self` if already owned. If borrowed, converts the value to owned
    /// using `TBooToOwned`.
    pub fn into_owned_with<TBooToOwned>(self) -> TOwned
    where
        TBooToOwned: BooToOwned<TBorrowed, TOwned>,
    {
        match self {
            Boo::Borrowed(borrowed) => TBooToOwned::convert_to_owned(borrowed),
            Boo::Owned(owned) => owned,
        }
    }
}

impl<'a, TBorrowed, TOwned> Boo<'a, TBorrowed, TOwned>
where
    TOwned: Borrow<TBorrowed>,
    TBorrowed: ?Sized,
{
    pub(crate) fn borrow_internal(&self) -> &TBorrowed {
        match self {
            Boo::Borrowed(value) => *value,
            Boo::Owned(value) => value.borrow(),
        }
    }
}

impl<'a, TBorrowed, TOwned> Boo<'a, TBorrowed, TOwned>
where
    TBorrowed: ToOwned<Owned = TOwned>,
    TOwned: Borrow<TBorrowed>,
    TBorrowed: ?Sized,
{
    pub fn into_owned(self) -> TOwned {
        match self {
            Boo::Borrowed(borrowed) => borrowed.to_owned(),
            Boo::Owned(owned) => owned,
        }
    }
}

impl<'a, TBorrowed, TOwned> Default for Boo<'a, TBorrowed, TOwned>
where
    TOwned: Default,
    TBorrowed: ?Sized,
{
    fn default() -> Self {
        Boo::Owned(TOwned::default())
    }
}

impl<'a, TBorrowed, TOwned> Borrow<TBorrowed> for Boo<'a, TBorrowed, TOwned>
where
    TOwned: Borrow<TBorrowed>,
    TBorrowed: ?Sized,
{
    fn borrow(&self) -> &TBorrowed {
        match self {
            Boo::Borrowed(value) => *value,
            Boo::Owned(value) => value.borrow(),
        }
    }
}

impl<'a, TBorrowed, TOwned> AsRef<TBorrowed> for Boo<'a, TBorrowed, TOwned>
where
    TOwned: AsRef<TBorrowed>,
    TBorrowed: ?Sized,
{
    fn as_ref(&self) -> &TBorrowed {
        match self {
            Boo::Borrowed(value) => *value,
            Boo::Owned(value) => value.as_ref(),
        }
    }
}

impl<'a, TBorrowed, TOwned> Deref for Boo<'a, TBorrowed, TOwned>
where
    TOwned: Deref<Target = TBorrowed>,
    TBorrowed: ?Sized,
{
    type Target = TBorrowed;

    fn deref(&self) -> &Self::Target {
        match self {
            Boo::Borrowed(value) => *value,
            Boo::Owned(value) => value.borrow(),
        }
    }
}

impl<'a, TBorrowed, TOwned> Hash for Boo<'a, TBorrowed, TOwned>
where
    TOwned: Borrow<TBorrowed>,
    TBorrowed: Hash,
    TBorrowed: ?Sized,
{
    fn hash<H: Hasher>(&self, state: &mut H) {
        self.borrow_internal().hash(state)
    }
}

impl<'a, TBorrowed, TOwned> Display for Boo<'a, TBorrowed, TOwned>
where
    TOwned: Borrow<TBorrowed>,
    TBorrowed: Display,
    TBorrowed: ?Sized,
{
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        Display::fmt(self.borrow_internal(), f)
    }
}

impl<'a, TBorrowed, TOwned> Clone for Boo<'a, TBorrowed, TOwned>
where
    TOwned: Clone,
    TBorrowed: ?Sized,
{
    fn clone(&self) -> Self {
        match self {
            Boo::Borrowed(value) => Boo::Borrowed(value),
            Boo::Owned(value) => Boo::Owned(value.clone()),
        }
    }
}