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
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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292

use core::ops;

use bstr::BStr;

/// Ensure that callers cannot implement `SliceIndex` by making an
/// umplementable trait its super trait.
pub trait Sealed {}
impl Sealed for usize {}
impl Sealed for ops::Range<usize> {}
impl Sealed for ops::RangeTo<usize> {}
impl Sealed for ops::RangeFrom<usize> {}
impl Sealed for ops::RangeFull {}
impl Sealed for ops::RangeInclusive<usize> {}
impl Sealed for ops::RangeToInclusive<usize> {}

/// A trait that parameterizes the different types of indexing a byte string.
///
/// In general, this trait makes it possible to define generic routines like
/// `get` that can accept either single positions or ranges, and return single
/// bytes or slices, respectively.
///
/// This trait is sealed such that callers cannot implement it. In general,
/// callers should not need to interact with this trait directly unless you're
/// defining generic functions that index or slice a byte string.
pub trait SliceIndex: Sealed {
    /// The output type returned by methods. For indexing by position, this
    /// is always a single byte (`u8`). For ranges, this is always a slice
    /// (`BStr`).
    type Output: ?Sized;

    /// Returns a shared reference to the output at this location, if in
    /// bounds.
    fn get(self, slice: &BStr) -> Option<&Self::Output>;

    /// Returns a mutable reference to the output at this location, if in
    /// bounds.
    fn get_mut(self, slice: &mut BStr) -> Option<&mut Self::Output>;

    /// Returns a shared reference to the output at this location, without
    /// performing any bounds checking.
    unsafe fn get_unchecked(self, slice: &BStr) -> &Self::Output;

    /// Returns a mutable reference to the output at this location, without
    /// performing any bounds checking.
    unsafe fn get_unchecked_mut(self, slice: &mut BStr) -> &mut Self::Output;

    /// Returns a shared reference to the output at this location, panicking
    /// if out of bounds.
    fn index(self, slice: &BStr) -> &Self::Output;

    /// Returns a mutable reference to the output at this location, panicking
    /// if out of bounds.
    fn index_mut(self, slice: &mut BStr) -> &mut Self::Output;
}

impl SliceIndex for usize {
    type Output = u8;

    #[inline]
    fn get(self, slice: &BStr) -> Option<&u8> {
        slice.as_bytes().get(self)
    }

    #[inline]
    fn get_mut(self, slice: &mut BStr) -> Option<&mut u8> {
        slice.as_bytes_mut().get_mut(self)
    }

    #[inline]
    unsafe fn get_unchecked(self, slice: &BStr) -> &u8 {
        slice.as_bytes().get_unchecked(self)
    }

    #[inline]
    unsafe fn get_unchecked_mut(self, slice: &mut BStr) -> &mut u8 {
        slice.as_bytes_mut().get_unchecked_mut(self)
    }

    #[inline]
    fn index(self, slice: &BStr) -> &u8 {
        &slice.as_bytes()[self]
    }

    #[inline]
    fn index_mut(self, slice: &mut BStr) -> &mut u8 {
        &mut slice.as_bytes_mut()[self]
    }
}

impl SliceIndex for ops::Range<usize> {
    type Output = BStr;

    #[inline]
    fn get(self, slice: &BStr) -> Option<&BStr> {
        slice.as_bytes().get(self).map(BStr::new)
    }

    #[inline]
    fn get_mut(self, slice: &mut BStr) -> Option<&mut BStr> {
        slice.as_bytes_mut().get_mut(self).map(BStr::new_mut)
    }

    #[inline]
    unsafe fn get_unchecked(self, slice: &BStr) -> &BStr {
        BStr::new(slice.as_bytes().get_unchecked(self))
    }

    #[inline]
    unsafe fn get_unchecked_mut(self, slice: &mut BStr) -> &mut BStr {
        BStr::new_mut(slice.as_bytes_mut().get_unchecked_mut(self))
    }

    #[inline]
    fn index(self, slice: &BStr) -> &BStr {
        &slice[self]
    }

    #[inline]
    fn index_mut(self, slice: &mut BStr) -> &mut BStr {
        &mut slice[self]
    }
}

impl SliceIndex for ops::RangeTo<usize> {
    type Output = BStr;

    #[inline]
    fn get(self, slice: &BStr) -> Option<&BStr> {
        slice.as_bytes().get(self).map(BStr::new)
    }

    #[inline]
    fn get_mut(self, slice: &mut BStr) -> Option<&mut BStr> {
        slice.as_bytes_mut().get_mut(self).map(BStr::new_mut)
    }

    #[inline]
    unsafe fn get_unchecked(self, slice: &BStr) -> &BStr {
        BStr::new(slice.as_bytes().get_unchecked(self))
    }

    #[inline]
    unsafe fn get_unchecked_mut(self, slice: &mut BStr) -> &mut BStr {
        BStr::new_mut(slice.as_bytes_mut().get_unchecked_mut(self))
    }

    #[inline]
    fn index(self, slice: &BStr) -> &BStr {
        &slice[self]
    }

    #[inline]
    fn index_mut(self, slice: &mut BStr) -> &mut BStr {
        &mut slice[self]
    }
}

impl SliceIndex for ops::RangeFrom<usize> {
    type Output = BStr;

    #[inline]
    fn get(self, slice: &BStr) -> Option<&BStr> {
        slice.as_bytes().get(self).map(BStr::new)
    }

    #[inline]
    fn get_mut(self, slice: &mut BStr) -> Option<&mut BStr> {
        slice.as_bytes_mut().get_mut(self).map(BStr::new_mut)
    }

    #[inline]
    unsafe fn get_unchecked(self, slice: &BStr) -> &BStr {
        BStr::new(slice.as_bytes().get_unchecked(self))
    }

    #[inline]
    unsafe fn get_unchecked_mut(self, slice: &mut BStr) -> &mut BStr {
        BStr::new_mut(slice.as_bytes_mut().get_unchecked_mut(self))
    }

    #[inline]
    fn index(self, slice: &BStr) -> &BStr {
        &slice[self]
    }

    #[inline]
    fn index_mut(self, slice: &mut BStr) -> &mut BStr {
        &mut slice[self]
    }
}

impl SliceIndex for ops::RangeFull {
    type Output = BStr;

    #[inline]
    fn get(self, slice: &BStr) -> Option<&BStr> {
        slice.as_bytes().get(self).map(BStr::new)
    }

    #[inline]
    fn get_mut(self, slice: &mut BStr) -> Option<&mut BStr> {
        slice.as_bytes_mut().get_mut(self).map(BStr::new_mut)
    }

    #[inline]
    unsafe fn get_unchecked(self, slice: &BStr) -> &BStr {
        BStr::new(slice.as_bytes().get_unchecked(self))
    }

    #[inline]
    unsafe fn get_unchecked_mut(self, slice: &mut BStr) -> &mut BStr {
        BStr::new_mut(slice.as_bytes_mut().get_unchecked_mut(self))
    }

    #[inline]
    fn index(self, slice: &BStr) -> &BStr {
        &slice[self]
    }

    #[inline]
    fn index_mut(self, slice: &mut BStr) -> &mut BStr {
        &mut slice[self]
    }
}

impl SliceIndex for ops::RangeInclusive<usize> {
    type Output = BStr;

    #[inline]
    fn get(self, slice: &BStr) -> Option<&BStr> {
        slice.as_bytes().get(self).map(BStr::new)
    }

    #[inline]
    fn get_mut(self, slice: &mut BStr) -> Option<&mut BStr> {
        slice.as_bytes_mut().get_mut(self).map(BStr::new_mut)
    }

    #[inline]
    unsafe fn get_unchecked(self, slice: &BStr) -> &BStr {
        BStr::new(slice.as_bytes().get_unchecked(self))
    }

    #[inline]
    unsafe fn get_unchecked_mut(self, slice: &mut BStr) -> &mut BStr {
        BStr::new_mut(slice.as_bytes_mut().get_unchecked_mut(self))
    }

    #[inline]
    fn index(self, slice: &BStr) -> &BStr {
        &slice[self]
    }

    #[inline]
    fn index_mut(self, slice: &mut BStr) -> &mut BStr {
        &mut slice[self]
    }
}

impl SliceIndex for ops::RangeToInclusive<usize> {
    type Output = BStr;

    #[inline]
    fn get(self, slice: &BStr) -> Option<&BStr> {
        slice.as_bytes().get(self).map(BStr::new)
    }

    #[inline]
    fn get_mut(self, slice: &mut BStr) -> Option<&mut BStr> {
        slice.as_bytes_mut().get_mut(self).map(BStr::new_mut)
    }

    #[inline]
    unsafe fn get_unchecked(self, slice: &BStr) -> &BStr {
        BStr::new(slice.as_bytes().get_unchecked(self))
    }

    #[inline]
    unsafe fn get_unchecked_mut(self, slice: &mut BStr) -> &mut BStr {
        BStr::new_mut(slice.as_bytes_mut().get_unchecked_mut(self))
    }

    #[inline]
    fn index(self, slice: &BStr) -> &BStr {
        &slice[self]
    }

    #[inline]
    fn index_mut(self, slice: &mut BStr) -> &mut BStr {
        &mut slice[self]
    }
}