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
use core::ops::{Deref, DerefMut};
use core::{ptr, slice};

#[cfg(feature = "nightly")]
#[path = "loaf_nightly.rs"]
mod nightly;
#[cfg(feature = "nightly")]
pub use nightly::*;

/// Slice that guarantees to have at least one element
/// # Usage
/// The implementation is very minimal, it only contains things that have reason
/// to be here. If you want to use slice iterators or other slice methods,
/// consider using them indirectly via [as_slice](Loaf::as_slice) or
/// [as_mut_slice](Loaf::as_mut_slice)
#[repr(C)] /* Just to be sure */
pub struct Loaf<T> {
    pub loaf: [T; 1],
    pub rest: [T],
}

impl<T> Loaf<T> {
    /// Returns length of the underlying slice
    /// ```
    /// # use loaf::Loaf;
    /// let slice = &[0u8, 1, 2, 3, 4];
    /// let loaf = Loaf::from_slice(slice).unwrap();
    /// assert_eq!(loaf.len(), slice.len());
    /// ```
    pub fn len(&self) -> usize {
        /* self.loaf.len() == 1 */
        1 + self.rest.len()
    }

    /* Using bracket syntax on arrays has the same performance
     * as using get_unchecked(), plus code does not compile when
     * array has length of zero (can be useful with const generics)
     */
    /// Returns a reference to the first element
    /// ```
    /// # use loaf::Loaf;
    /// let slice = &[0u8, 1, 2, 3, 4];
    /// let loaf = Loaf::from_slice(slice).unwrap();
    /// assert_eq!(*loaf.first(), 0);
    /// ```
    pub fn first(&self) -> &T {
        &self.loaf[0]
    }
    /// Returns a mutable reference to the first element
    /// ```
    /// # use loaf::Loaf;
    /// let slice = &mut [0u8, 1, 2, 3, 4];
    /// let loaf = Loaf::from_slice_mut(slice).unwrap();
    /// *loaf.first_mut() = 42;
    /// assert_eq!(*loaf.first(), 42);
    /// ```
    pub fn first_mut(&mut self) -> &mut T {
        &mut self.loaf[0]
    }
    /// Returns a reference to the last element
    /// ```
    /// # use loaf::Loaf;
    /// let slice = &[0u8, 1, 2, 3, 4];
    /// let loaf = Loaf::from_slice(slice).unwrap();
    /// assert_eq!(*loaf.last(), 4);
    /// ```
    pub fn last(&self) -> &T {
        match self.rest.last() {
            Some(x) => x,
            None => &self.loaf[0],
        }
    }
    /// Returns a mutable reference to the last element
    /// ```
    /// # use loaf::Loaf;
    /// let slice = &mut [0u8, 1, 2, 3, 4];
    /// let loaf = Loaf::from_slice_mut(slice).unwrap();
    /// *loaf.last_mut() = 42;
    /// assert_eq!(*loaf.last(), 42);
    /// ```
    pub fn last_mut(&mut self) -> &mut T {
        match self.rest.last_mut() {
            Some(x) => x,
            None => &mut self.loaf[0],
        }
    }
    /// Returns a reference to the first element and the rest of slice
    /// ```
    /// # use loaf::Loaf;
    /// let slice = &[0u8, 1, 2, 3, 4];
    /// let loaf = Loaf::from_slice(slice).unwrap();
    /// let (first, rest) = loaf.split_first();
    /// assert_eq!(*first, 0);
    /// assert_eq!(rest, &[1, 2, 3, 4]);
    /// ```
    pub fn split_first(&self) -> (&T, &[T]) {
        (&self.loaf[0], &self.rest)
    }
    /// Returns a mutable reference to the first element and the rest of slice
    /// ```
    /// # use loaf::Loaf;
    /// let slice = &mut [0u8, 1, 2, 3, 4];
    /// let loaf = Loaf::from_slice_mut(slice).unwrap();
    /// let (first, rest) = loaf.split_first_mut();
    /// *first = 40;
    /// rest[0] = 41;
    /// // slice[0] = 0; // this line does not compile, because slice is borrowed mutably
    /// assert_eq!(*first, 40);
    /// assert_eq!(rest, &[41, 2, 3, 4]);
    /// ```
    pub fn split_first_mut(&mut self) -> (&mut T, &mut [T]) {
        (&mut self.loaf[0], &mut self.rest)
    }

    #[inline(always)]
    fn from_raw_parts(ptr: *const T, len: usize) -> *const Self {
        ptr::slice_from_raw_parts(ptr, len) as *const Self
    }
    #[inline(always)]
    fn from_raw_parts_mut(ptr: *mut T, len: usize) -> *mut Self {
        ptr::slice_from_raw_parts(ptr, len) as *mut Self
    }

    /// Casts a `&[T]` with at least one element into `&Loaf<T>`.
    /// If slice does not contain any element, None is returned
    /// ```
    /// # use loaf::Loaf;
    /// let slice = &[0u8, 1, 2, 3, 4];
    /// let loaf = Loaf::from_slice(slice).unwrap();
    /// assert_eq!(loaf.loaf, [0]);
    /// assert_eq!(loaf.rest, [1, 2, 3, 4]);
    ///
    /// let slice: &[u8] = &[];
    /// let optionloaf = Loaf::from_slice(slice);
    /// assert!(optionloaf.is_none());
    /// ```
    pub fn from_slice(slice: &[T]) -> Option<&Self> {
        let len = match slice.len().checked_sub(1) {
            Some(x) => x,
            None => return None,
        };
        let ptr = slice.as_ptr();
        let loaf = unsafe { &*Self::from_raw_parts(ptr, len) };

        return Some(loaf);
    }

    /// Casts a `&mut [T]` with at least one element into `&mut Loaf<T>`.
    /// If slice does not contain any element, None is returned
    /// ```
    /// # use loaf::Loaf;
    /// let slice = &mut [0u8, 1, 2, 3, 4];
    /// let loaf = Loaf::from_slice_mut(slice).unwrap();
    /// loaf.loaf[0] = 42;
    /// loaf.rest[3] = 14;
    /// assert_eq!(slice, &[42u8, 1, 2, 3, 14]);
    /// ```
    pub fn from_slice_mut(slice: &mut [T]) -> Option<&mut Self> {
        let len = match slice.len().checked_sub(1) {
            Some(x) => x,
            None => return None,
        };
        let ptr = slice.as_mut_ptr();
        let loaf = unsafe { &mut *Self::from_raw_parts_mut(ptr, len) };

        return Some(loaf);
    }

    /// Casts `&Loaf<T>` into `&[T]`
    /// ```
    /// # use loaf::Loaf;
    /// let slice = &[0u8, 1, 2, 3, 4];
    /// let loaf = Loaf::from_slice(slice).unwrap();
    /// assert_eq!(loaf.as_slice(), &[0u8, 1, 2, 3, 4]);
    /// ```
    pub fn as_slice(&self) -> &[T] {
        let len = self.len();
        let ptr = self as *const Self as *const T;
        unsafe { slice::from_raw_parts(ptr, len) }
    }

    /// Casts `&mut Loaf<T>` into `&mut [T]`
    /// ```
    /// # use loaf::Loaf;
    /// let slice = &mut [0u8, 1, 2, 3, 4];
    /// let loaf = Loaf::from_slice_mut(slice).unwrap();
    /// loaf.loaf[0] = 42;
    /// loaf.rest[3] = 14;
    /// assert_eq!(loaf.as_slice(), &[42u8, 1, 2, 3, 14]);
    /// ```
    pub fn as_mut_slice(&mut self) -> &mut [T] {
        let len = self.len();
        let ptr = self as *mut Self as *mut T;
        unsafe { slice::from_raw_parts_mut(ptr, len) }
    }

    /// Casts a `&[T]` into `&Loaf<T>`.
    /// # Safety
    /// Slice needs to hold at least one element
    pub unsafe fn from_slice_unchecked(slice: &[T]) -> &Self {
        let len = slice.len() - 1;
        let ptr = slice.as_ptr();
        #[allow(unused_unsafe)]
        unsafe {
            &*Self::from_raw_parts(ptr, len)
        }
    }
    /// Casts a `&mut [T]` into `&mut Loaf<T>`.
    /// # Safety
    /// Slice needs to hold at least one element
    pub unsafe fn from_slice_mut_unchecked(slice: &mut [T]) -> &mut Self {
        let len = slice.len() - 1;
        let ptr = slice.as_mut_ptr();
        #[allow(unused_unsafe)]
        unsafe {
            &mut *Self::from_raw_parts_mut(ptr, len)
        }
    }
}

#[cfg(feature = "alloc")]
use crate::alloc::boxed::Box;

#[cfg(feature = "alloc")]
/// Avaliable with `alloc` feature
impl<T> Loaf<T> {
    /// Consumes a boxed slice returning a boxed Loaf.\
    /// If length of the slice is zero, the Box is returned back as error
    /// ```
    /// # use loaf::Loaf;
    /// let x: Box<[u8]> = Box::new([1, 2, 3]);
    /// let loaf = Loaf::try_from_boxed_slice(x).unwrap();
    /// assert_eq!(loaf.loaf, [1u8]);
    /// assert_eq!(loaf.rest, [2u8, 3]);
    ///
    /// let x: Box<[u8]> = Box::new([]);
    /// let b: Box<[u8]> = match Loaf::try_from_boxed_slice(x) {
    ///     Ok(_) => unreachable!(),
    ///     Err(b) => b,
    /// };
    /// ```
    pub fn try_from_boxed_slice(boxed: Box<[T]>) -> Result<Box<Self>, Box<[T]>> {
        let len = match boxed.len().checked_sub(1) {
            Some(x) => x,
            None => return Err(boxed),
        };

        let ptr = Box::into_raw(boxed) as *mut T;
        let loaf = Self::from_raw_parts_mut(ptr, len);

        let result = unsafe { Box::from_raw(loaf) };
        return Ok(result);
    }

    /// Consumes a boxed Loaf returning a boxed slice
    /// ```
    /// # use loaf::Loaf;
    /// let x: Box<[u8]> = Box::new([1, 2, 3]);
    /// let loaf = Loaf::try_from_boxed_slice(x).unwrap();
    /// assert_eq!(loaf.loaf, [1u8]);
    /// assert_eq!(loaf.rest, [2u8, 3]);
    /// assert_eq!(loaf.into_boxed_slice().as_ref(), &[1u8, 2, 3]);
    /// ```
    pub fn into_boxed_slice(self: Box<Self>) -> Box<[T]> {
        let len = self.len();
        let ptr = Box::into_raw(self) as *mut T;
        let fatptr = ptr::slice_from_raw_parts_mut(ptr, len);

        unsafe { Box::from_raw(fatptr) }
    }
}

impl<T> Deref for Loaf<T> {
    type Target = [T];
    fn deref(&self) -> &Self::Target {
        self.as_slice()
    }
}

impl<T> DerefMut for Loaf<T> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        self.as_mut_slice()
    }
}