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 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
use core::marker::PhantomData;
use core::mem::size_of;
use crate::buf::{Buf, Load};
use crate::endian::{ByteOrder, Native};
use crate::error::{Error, ErrorKind, IntoRepr};
use crate::pointer::{Ref, Size};
use crate::slice::Slice;
use crate::{DefaultSize, ZeroCopy};
/// A packed slice representation that uses exactly `O` and `L` for offset and
/// length respectively.
///
/// This is functionally equivalent to a [`Ref<[T]>`], but pointer and metadata
/// `L` does not have to be the same size and its representation is packed.
///
/// ```
/// use core::mem::{size_of, align_of};
///
/// use musli_zerocopy::slice::Packed;
/// use musli_zerocopy::{DefaultSize, Ref};
///
/// assert_eq!(size_of::<Packed<[u32], u32, u8>>(), 5);
/// assert_eq!(align_of::<Packed<[u32], u32, u8>>(), 1);
///
/// assert_eq!(size_of::<Ref<[u32]>>(), size_of::<DefaultSize>() * 2);
/// assert_eq!(align_of::<Ref<[u32]>>(), align_of::<DefaultSize>());
/// ```
///
/// Since this implements [`Slice<T>`] it can be used to build collection
/// flavors like [`trie::Flavor`].
///
/// [`trie::Flavor`]: crate::trie::Flavor
#[derive(ZeroCopy)]
#[zero_copy(crate, bounds = {O: ZeroCopy, L: ZeroCopy})]
#[repr(C, packed)]
pub struct Packed<T: ?Sized, O: Size = DefaultSize, L: Size = DefaultSize, E: ByteOrder = Native> {
offset: O,
len: L,
#[zero_copy(ignore)]
_marker: PhantomData<(E, T)>,
}
impl<T, O: Size, L: Size, E: ByteOrder> Slice for Packed<[T], O, L, E>
where
T: ZeroCopy,
O: TryFrom<usize>,
L: TryFrom<usize>,
{
type Item = T;
type ItemRef = Ref<T, E, usize>;
#[inline]
fn from_ref<A: ByteOrder, B: Size>(slice: Ref<[T], A, B>) -> Self
where
T: ZeroCopy,
{
Self::with_metadata(slice.offset(), slice.len())
}
#[inline]
fn try_from_ref<A: ByteOrder, B: Size>(slice: Ref<[T], A, B>) -> Result<Self, Error>
where
T: ZeroCopy,
{
Self::try_with_metadata(slice.offset(), slice.len())
}
#[inline]
fn with_metadata(offset: usize, len: usize) -> Self {
Packed::from_raw_parts(offset, len)
}
#[inline]
fn try_with_metadata(offset: usize, len: usize) -> Result<Self, Error> {
Packed::try_from_raw_parts(offset, len)
}
#[inline]
fn get(self, index: usize) -> Option<Self::ItemRef> {
Packed::get(self, index)
}
#[inline]
fn split_at(self, at: usize) -> (Self, Self) {
Packed::split_at(self, at)
}
#[inline]
fn get_unchecked(self, index: usize) -> Self::ItemRef {
Packed::get_unchecked(self, index)
}
#[inline]
fn offset(self) -> usize {
Packed::offset(self)
}
#[inline]
fn len(self) -> usize {
Packed::len(self)
}
#[inline]
fn is_empty(self) -> bool {
Packed::is_empty(self)
}
}
impl<T, O: Size, L: Size, E: ByteOrder> Packed<[T], O, L, E>
where
T: ZeroCopy,
{
/// Construct a packed slice from a reference.
#[inline]
pub fn from_ref<A: ByteOrder, B: Size>(slice: Ref<[T], A, B>) -> Self
where
T: ZeroCopy,
{
Self::from_raw_parts(slice.offset(), slice.len())
}
/// Construct a packed slice from its raw parts.
///
/// # Panics
///
/// This panics in case any components in the path overflow its representation.
#[inline]
pub fn from_raw_parts(offset: usize, len: usize) -> Self
where
O: TryFrom<usize>,
L: TryFrom<usize>,
{
let Some(offset) = O::try_from(offset).ok() else {
panic!("Offset {offset:?} not in legal range 0-{}", O::MAX);
};
let Some(len) = L::try_from(len).ok() else {
panic!("Length {len:?} not in legal range 0-{}", L::MAX);
};
Self {
offset: O::swap_bytes::<E>(offset),
len: L::swap_bytes::<E>(len),
_marker: PhantomData,
}
}
/// Try to construct a packed slice from its raw parts.
///
/// # Errors
///
/// This errors in case any components in the path overflow its representation.
///
/// # Examples
///
/// ```
/// use musli_zerocopy::slice::Packed;
///
/// let slice = Packed::<[u32], u32, u8>::try_from_raw_parts(42, 2)?;
/// assert_eq!(slice.offset(), 42);
///
/// assert!(Packed::<[u32], u32, u8>::try_from_raw_parts(42, usize::MAX).is_err());
/// # Ok::<_, musli_zerocopy::Error>(())
/// ```
#[inline]
pub fn try_from_raw_parts(offset: usize, len: usize) -> Result<Self, Error>
where
O: TryFrom<usize> + IntoRepr,
L: TryFrom<usize> + IntoRepr,
{
let Some(offset) = O::try_from(offset).ok() else {
return Err(Error::new(ErrorKind::InvalidOffsetRange {
offset: usize::into_repr(offset),
max: O::into_repr(O::MAX),
}));
};
let Some(len) = L::try_from(len).ok() else {
return Err(Error::new(ErrorKind::InvalidMetadataRange {
metadata: usize::into_repr(len),
max: L::into_repr(L::MAX),
}));
};
Ok(Self {
offset: O::swap_bytes::<E>(offset),
len: L::swap_bytes::<E>(len),
_marker: PhantomData,
})
}
/// 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::OwnedBuf;
/// use musli_zerocopy::slice::Packed;
///
/// let mut buf = OwnedBuf::new();
///
/// let slice: Packed<[i32]> = Packed::from_ref(buf.store_slice(&[1, 2, 3, 4]));
///
/// let two = slice.get(2).expect("Missing element 2");
/// assert_eq!(buf.load(two)?, &3);
///
/// assert!(slice.get(4).is_none());
/// # Ok::<_, musli_zerocopy::Error>(())
/// ```
#[inline]
pub fn get(self, index: usize) -> Option<Ref<T, E, usize>> {
if index >= self.len() {
return None;
}
Some(self.get_unchecked(index))
}
/// Split the slice reference at the given position `at`.
///
/// # Panics
///
/// This panics if the given range is out of bounds.
///
/// # Examples
///
/// ```
/// use musli_zerocopy::OwnedBuf;
/// use musli_zerocopy::slice::Packed;
///
/// let mut buf = OwnedBuf::new();
///
/// let slice: Packed<[i32]> = Packed::from_ref(buf.store_slice(&[1, 2, 3, 4]));
///
/// buf.align_in_place();
///
/// 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::<_, musli_zerocopy::Error>(())
/// ```
#[inline]
pub fn split_at(self, at: usize) -> (Self, Self) {
let offset = self.offset.as_usize::<E>();
let len = self.len.as_usize::<E>();
assert!(at <= len, "Split point {at} is out of bounds 0..={len}");
let a = Self::from_raw_parts(offset, at);
let b = Self::from_raw_parts(offset + at * size_of::<T>(), len - at);
(a, b)
}
/// 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()`]: Packed::get
///
/// # Examples
///
/// ```
/// use musli_zerocopy::OwnedBuf;
/// use musli_zerocopy::slice::Packed;
///
/// let mut buf = OwnedBuf::new();
///
/// let slice: Packed<[i32]> = Packed::from_ref(buf.store_slice(&[1, 2, 3, 4]));
///
/// 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::<_, musli_zerocopy::Error>(())
/// ```
#[inline]
pub fn get_unchecked(self, index: usize) -> Ref<T, E, usize> {
let offset = self.offset.as_usize::<E>() + size_of::<T>() * index;
Ref::new(offset)
}
/// Get the offset the packed slice points to.
///
/// # Examples
///
/// ```
/// use musli_zerocopy::slice::Packed;
///
/// let slice = Packed::<[u32], u32, u8>::from_raw_parts(42, 2);
/// assert_eq!(slice.offset(), 42);
/// ```
pub fn offset(self) -> usize {
self.offset.as_usize::<E>()
}
/// Return the number of elements in the packed slice.
///
/// # Examples
///
/// ```
/// use musli_zerocopy::slice::Packed;
///
/// let slice = Packed::<[u32], u32, u8>::from_raw_parts(0, 2);
/// assert_eq!(slice.len(), 2);
/// ```
#[inline]
pub fn len(self) -> usize {
self.len.as_usize::<E>()
}
/// Test if the packed slice is empty.
///
/// # Examples
///
/// ```
/// use musli_zerocopy::slice::Packed;
///
/// let slice = Packed::<[u32], u32, u8>::from_raw_parts(0, 0);
/// assert!(slice.is_empty());
///
/// let slice = Packed::<[u32], u32, u8>::from_raw_parts(0, 2);
/// assert!(!slice.is_empty());
/// ```
#[inline]
pub fn is_empty(self) -> bool {
self.len.is_zero()
}
}
impl<T, O, L, E: ByteOrder> Load for Packed<[T], O, L, E>
where
T: ZeroCopy,
O: Size,
L: Size,
{
type Target = [T];
#[inline]
fn load<'buf>(&self, buf: &'buf Buf) -> Result<&'buf Self::Target, Error> {
buf.load(Ref::<[T], Native, usize>::with_metadata(
self.offset.as_usize::<E>(),
self.len.as_usize::<E>(),
))
}
}
impl<T, O, L, E: ByteOrder> Clone for Packed<[T], O, L, E>
where
O: Size,
L: Size,
{
#[inline]
fn clone(&self) -> Self {
*self
}
}
impl<T, O, L, E: ByteOrder> Copy for Packed<[T], O, L, E>
where
O: Size,
L: Size,
{
}