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 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
use crate::buf::Load;
use crate::endian::ByteOrder;
use crate::error::Error;
use crate::pointer::{Ref, Size};
use crate::traits::ZeroCopy;
mod sealed {
use crate::endian::ByteOrder;
use crate::pointer::{Ref, Size};
use crate::slice::Packed;
use crate::traits::ZeroCopy;
pub trait Sealed {}
impl<T, E: ByteOrder, O: Size> Sealed for Ref<[T], E, O> where T: ZeroCopy {}
impl<T, O: Size, L: Size, E: ByteOrder> Sealed for Packed<[T], O, L, E> {}
}
/// A trait implemented by slice-like types.
pub trait Slice: self::sealed::Sealed + Copy + ZeroCopy + Load<Target = [Self::Item]> {
/// The item in an unsized slice, or the `T` in `[T]`.
type Item;
/// A returned reference to an item in a slice.
type ItemRef: Load<Target = Self::Item>;
/// Construct a slice from a [`Ref<[Self::Item]>`].
///
/// # Panics
///
/// This method panics if construction of the slice would overflow any of
/// its parameters.
///
/// # Examples
///
/// ```
/// use musli_zerocopy::{Ref, ZeroCopy};
/// use musli_zerocopy::slice::Slice;
///
/// fn generic<S>(r: Ref<[S::Item]>) -> S where S: Slice, S::Item: ZeroCopy {
/// S::from_ref(r)
/// }
/// ```
fn from_ref<E: ByteOrder, O: Size>(slice: Ref<[Self::Item], E, O>) -> Self
where
Self::Item: ZeroCopy;
/// Try to construct a slice from a [`Ref<[Self::Item]>`].
///
/// # Errors
///
/// This method errors if construction of the slice would overflow any of
/// its parameters.
///
/// # Examples
///
/// ```
/// use musli_zerocopy::{Error, Ref, ZeroCopy};
/// use musli_zerocopy::slice::Slice;
///
/// fn generic<S>(r: Ref<[S::Item]>) -> Result<S, Error> where S: Slice, S::Item: ZeroCopy {
/// S::try_from_ref(r)
/// }
/// ```
fn try_from_ref<E: ByteOrder, O: Size>(slice: Ref<[Self::Item], E, O>) -> Result<Self, Error>
where
Self::Item: ZeroCopy;
/// Construct a slice from its `offset` and `len`.
///
/// # Panics
///
/// This method panics if construction of the slice would overflow any of
/// its parameters.
///
/// # Examples
///
/// ```
/// use musli_zerocopy::Ref;
/// use musli_zerocopy::slice::Slice;
///
/// fn generic<S>() -> S where S: Slice {
/// S::with_metadata(0, 10)
/// }
/// ```
fn with_metadata(offset: usize, len: usize) -> Self;
/// Construct a slice from its `offset` and `len`.
///
/// # Errors
///
/// This method errors if construction of the slice would overflow any of
/// its parameters.
///
/// # Examples
///
/// ```
/// use musli_zerocopy::Ref;
/// use musli_zerocopy::slice::Slice;
///
/// fn generic<S>() -> S where S: Slice {
/// S::with_metadata(0, 10)
/// }
/// ```
fn try_with_metadata(offset: usize, len: usize) -> Result<Self, Error>;
/// Try to get a reference directly out of the slice without validation.
///
/// This avoids having to validate every element in a slice in order to
/// address them.
///
/// # Examples
///
/// ```
/// use musli_zerocopy::{Buf, Error, OwnedBuf};
/// use musli_zerocopy::slice::Slice;
///
/// fn generic<S>(buf: &Buf, slice: S) -> Result<(), Error>
/// where
/// S: Slice<Item = i32>
/// {
/// let two = slice.get(2).expect("Missing element 2");
/// assert_eq!(buf.load(two)?, &3);
///
/// assert!(slice.get(4).is_none());
/// Ok(())
/// }
///
/// let mut buf = OwnedBuf::new();
/// let slice = buf.store_slice(&[1, 2, 3, 4]);
///
/// generic(&buf, slice)?;
/// # Ok::<_, musli_zerocopy::Error>(())
/// ```
fn get(self, index: usize) -> Option<Self::ItemRef>;
/// Split the slice at the given position `at`.
///
/// # Panics
///
/// This panics if the given range is out of bounds.
///
/// # Examples
///
/// ```
/// use musli_zerocopy::{Buf, Error, OwnedBuf};
/// use musli_zerocopy::slice::Slice;
///
/// fn generic<S>(buf: &Buf, slice: S) -> Result<(), Error>
/// where
/// S: Slice<Item = i32>
/// {
/// let (a, b) = slice.split_at(3);
/// let (c, d) = slice.split_at(4);
///
/// assert_eq!(buf.load(a)?, &[1, 2, 3]);
/// assert_eq!(buf.load(b)?, &[4]);
/// assert_eq!(buf.load(c)?, &[1, 2, 3, 4]);
/// assert_eq!(buf.load(d)?, &[]);
/// Ok(())
/// }
///
/// let mut buf = OwnedBuf::new();
/// let slice = buf.store_slice(&[1, 2, 3, 4]);
///
/// buf.align_in_place();
///
/// generic(&buf, slice)?;
/// # Ok::<_, musli_zerocopy::Error>(())
/// ```
fn split_at(self, at: usize) -> (Self, Self);
/// Get an unchecked reference directly out of the slice without validation.
///
/// This avoids having to validate every element in a slice in order to
/// address them.
///
/// In contrast to [`get()`], this does not check that the index is within
/// the bounds of the current slice, all though it's not unsafe since it
/// cannot lead to anything inherently unsafe. Only garbled data.
///
/// [`get()`]: Slice::get
///
/// # Examples
///
/// ```
/// use musli_zerocopy::{Buf, Error, Ref, OwnedBuf};
/// use musli_zerocopy::slice::Slice;
///
/// // A method generic over a specific slice implementation.
/// fn generic<S>(buf: &Buf, slice: S) -> Result<(), Error>
/// where
/// S: Slice<Item = i32>
/// {
/// let two = slice.get_unchecked(2);
/// assert_eq!(buf.load(two)?, &3);
///
/// let oob = slice.get_unchecked(4);
/// assert!(buf.load(oob).is_err());
/// Ok(())
/// }
///
/// let mut buf = OwnedBuf::new();
///
/// let slice = buf.store_slice(&[1, 2, 3, 4]);
/// generic(&buf, slice)?;
/// # Ok::<_, musli_zerocopy::Error>(())
/// ```
fn get_unchecked(self, index: usize) -> Self::ItemRef;
/// Get the offset the slice points to.
///
/// # Examples
///
/// ```
/// use musli_zerocopy::Ref;
/// use musli_zerocopy::slice::Slice;
///
/// // A method generic over a specific slice implementation.
/// fn generic<S>(slice: S) where S: Slice {
/// assert_eq!(slice.offset(), 42);
/// }
///
/// let slice = Ref::<[i32]>::with_metadata(42, 2);
/// generic(slice);
/// ```
fn offset(self) -> usize;
/// Return the number of elements in the slice.
///
/// # Examples
///
/// ```
/// use musli_zerocopy::Ref;
/// use musli_zerocopy::slice::Slice;
///
/// // A method generic over a specific slice implementation.
/// fn generic<S>(slice: S) where S: Slice {
/// assert_eq!(slice.len(), 2);
/// }
///
/// let slice = Ref::<[i32]>::with_metadata(0, 2);
/// generic(slice);
/// ```
fn len(self) -> usize;
/// Test if the slice is empty.
///
/// # Examples
///
/// ```
/// use musli_zerocopy::Ref;
/// use musli_zerocopy::slice::Slice;
///
/// // A method generic over a specific slice implementation.
/// fn generic<S>(a: S, b: S) where S: Slice {
/// assert!(a.is_empty());
/// assert!(!b.is_empty());
/// }
///
/// let a = Ref::<[u32]>::with_metadata(0, 0);
/// let b = Ref::<[u32]>::with_metadata(0, 2);
/// generic(a, b);
/// ```
fn is_empty(self) -> bool;
}
impl<T, A: ByteOrder, B: Size> Slice for Ref<[T], A, B>
where
T: ZeroCopy,
{
type Item = T;
type ItemRef = Ref<T, A, B>;
#[inline]
fn from_ref<E: ByteOrder, O: Size>(slice: Ref<[T], E, O>) -> Self
where
T: ZeroCopy,
{
Ref::with_metadata(slice.offset(), slice.len())
}
#[inline]
fn try_from_ref<E: ByteOrder, O: Size>(slice: Ref<[T], E, O>) -> Result<Self, Error>
where
T: ZeroCopy,
{
Ref::try_with_metadata(slice.offset(), slice.len())
}
#[inline]
fn with_metadata(offset: usize, len: usize) -> Self {
Ref::with_metadata(offset, len)
}
#[inline]
fn try_with_metadata(offset: usize, len: usize) -> Result<Self, Error> {
Ref::try_with_metadata(offset, len)
}
#[inline]
fn get(self, index: usize) -> Option<Self::ItemRef> {
Ref::get(self, index)
}
#[inline]
fn split_at(self, at: usize) -> (Self, Self) {
Ref::split_at(self, at)
}
#[inline]
fn get_unchecked(self, index: usize) -> Self::ItemRef {
Ref::get_unchecked(self, index)
}
#[inline]
fn offset(self) -> usize {
Ref::<[T], _, _>::offset(self)
}
#[inline]
fn len(self) -> usize {
Ref::<[T], _, _>::len(self)
}
#[inline]
fn is_empty(self) -> bool {
Ref::<[T], _, _>::is_empty(self)
}
}