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
use crate::pointer::{CoerceSlice, Packable, Pointee, Size};
use crate::traits::ZeroCopy;
/// A trait indicating that a coercion from `Self` to `U` is correct from a size
/// perspective.
pub trait Coerce<U: ?Sized + Pointee>: Pointee {
/// Coerce metadata from `Self` to `U`.
///
/// Any overflow will wrap around.
fn coerce_metadata<O: Size>(
metadata: <Self::Metadata as Packable>::Packed<O>,
) -> <U::Metadata as Packable>::Packed<O>;
/// Try to coerce metadata from `Self` to `U`.
///
/// Any overflow will result in `None`.
fn try_coerce_metadata<O: Size>(
metadata: <Self::Metadata as Packable>::Packed<O>,
) -> Option<<U::Metadata as Packable>::Packed<O>>;
}
/// Defines a coercion from a slice `[T]` to `[U]`.
///
/// Since slices have a length which depends on the exact sizing of `T` and `U`,
/// this conversion is constrained by a special trait [`CoerceSlice<T>`].
impl<T, U> Coerce<[U]> for [T]
where
T: ZeroCopy,
U: ZeroCopy,
[T]: CoerceSlice<[U]>,
{
#[inline]
fn coerce_metadata<O: Size>(metadata: O) -> O {
<[T]>::resize(metadata)
}
#[inline]
fn try_coerce_metadata<O: Size>(metadata: O) -> Option<O> {
<[T]>::try_resize(metadata)
}
}
/// Defines the coercion from `str` to `[T]`.
///
/// Broadly speaking, this inherits the coercions which are possible for `[u8]`,
/// which basically limits it to `u8` and `i8` and other single byte types.
///
/// # Examples
///
/// ```
/// use musli_zerocopy::Ref;
///
/// let reference: Ref<str> = Ref::with_metadata(0, 12);
/// let reference2 = reference.coerce::<[u8]>();
/// let reference3 = reference.coerce::<[i8]>();
/// assert_eq!(reference2.len(), 12);
/// assert_eq!(reference3.len(), 12);
/// ```
impl<T> Coerce<[T]> for str
where
[u8]: CoerceSlice<[T]>,
T: ZeroCopy,
{
#[inline]
fn coerce_metadata<O: Size>(metadata: O) -> O {
<[u8]>::resize(metadata)
}
#[inline]
fn try_coerce_metadata<O: Size>(metadata: O) -> Option<O> {
<[u8]>::try_resize(metadata)
}
}
/// Defines the coercion from `[T]` to `str`.
///
/// Broadly speaking, this inherits the coercions which are possible into `[u8]`,
/// which means any type can be coerced into a `str`.
///
/// # Examples
///
/// ```
/// use musli_zerocopy::Ref;
///
/// let reference: Ref<[u32]> = Ref::with_metadata(0, 12);
/// let reference2 = reference.coerce::<str>();
/// assert_eq!(reference2.len(), 12 * 4);
/// ```
impl<T> Coerce<str> for [T]
where
[T]: CoerceSlice<[u8]>,
T: ZeroCopy,
{
#[inline]
fn coerce_metadata<O: Size>(metadata: O) -> O {
<[T]>::resize(metadata)
}
#[inline]
fn try_coerce_metadata<O: Size>(metadata: O) -> Option<O> {
<[T]>::try_resize(metadata)
}
}
macro_rules! same_size_inner {
($from:ty, {$($to:ty),*}) => {
$(
#[doc = concat!("Defines the coercion for `", stringify!($from) ,"` to `", stringify!($to), "`.")]
///
/// # Examples
///
/// ```
/// use musli_zerocopy::Ref;
///
#[doc = concat!("let reference: Ref<", stringify!($from), "> = Ref::zero();")]
#[doc = concat!("let reference2 = reference.coerce::<", stringify!($to), ">();")]
/// assert_eq!(reference.offset(), reference2.offset());
/// ```
impl Coerce<$to> for $from {
#[inline(always)]
fn coerce_metadata<O: Size>(metadata: ()) -> () {
metadata
}
#[inline(always)]
fn try_coerce_metadata<O: Size>(metadata: ()) -> Option<()> {
Some(metadata)
}
}
)*
}
}
macro_rules! same_size {
([$({$($from:ty),*}),*], [$($to:tt),*]) => {
$(
$(
same_size_inner!($from, $to);
)*
)*
};
}
same_size!([{u8, i8}], [{u8, i8}]);
same_size!([{u16, i16}], [{u16, i16, [u8; 2], [i8; 2]}]);
same_size!([{u32, i32}], [{u32, i32, [u16; 2], [i16; 2], [u8; 4], [i8; 4]}]);
same_size!([{u64, i64}], [{u64, i64, [u32; 2], [i32; 2], [u16; 4], [i16; 4], [u8; 8], [i8; 8]}]);
same_size!([{u128, i128}], [{u128, i128, [u64; 2], [i64; 2], [u32; 4], [i32; 4], [u16; 8], [i16; 8], [u8; 16], [i8; 16]}]);
/// Defines the primitive coercion from `T` to `[U]`.
///
/// This coercion results in a single element slice of type `T`, and is largely
/// defined through the help of [`CoerceSlice<T>`].
///
/// Note that coercing from a smaller to a larger type is not possible, since we
/// don't know how many elements of the smaller type is in use:
///
/// ```compile_fail
/// use musli_zerocopy::Ref;
///
/// let reference: Ref<u8> = Ref::zero();
/// let reference2 = reference.coerce::<[u32]>();
/// ```
///
/// # Examples
///
/// ```
/// use musli_zerocopy::Ref;
///
/// let reference: Ref<u32> = Ref::zero();
/// let reference2 = reference.coerce::<[u32]>();
/// assert_eq!(reference2.len(), 1);
///
/// let reference: Ref<u64> = Ref::zero();
/// let reference2 = reference.coerce::<[u32]>();
/// assert_eq!(reference2.len(), 2);
///
/// let reference: Ref<u128> = Ref::zero();
/// let reference2 = reference.coerce::<[u32]>();
/// assert_eq!(reference2.len(), 4);
/// ```
impl<T, U> Coerce<[U]> for T
where
T: ZeroCopy,
U: ZeroCopy,
[T]: CoerceSlice<[U]>,
{
#[inline]
fn coerce_metadata<O: Size>((): ()) -> <<[T] as Pointee>::Metadata as Packable>::Packed<O> {
<[T]>::resize(O::ONE)
}
#[inline]
fn try_coerce_metadata<O: Size>(
(): (),
) -> Option<<<[T] as Pointee>::Metadata as Packable>::Packed<O>> {
<[T]>::try_resize(O::ONE)
}
}
/// Defines the coercion from `[T; N]` to `[U]`.
///
/// This coercion results in a single element slice of type `T`, and is largely
/// defined through the help of [`CoerceSlice<T>`].
///
/// # Examples
///
/// ```
/// use musli_zerocopy::Ref;
///
/// let reference: Ref<[u32; 2]> = Ref::zero();
/// let reference2 = reference.coerce::<[u32]>();
/// assert_eq!(reference2.len(), 2);
///
/// let reference: Ref<[u128; 4]> = Ref::zero();
/// let reference2 = reference.coerce::<[u64]>();
/// assert_eq!(reference2.len(), 8);
/// ```
impl<T, const N: usize, U> Coerce<[U]> for [T; N]
where
T: ZeroCopy,
U: ZeroCopy,
[T]: CoerceSlice<[U]>,
{
#[inline]
fn coerce_metadata<O: Size>((): ()) -> <<[T] as Pointee>::Metadata as Packable>::Packed<O> {
let factor = O::try_from_usize(N).unwrap_or(O::MAX);
<[T]>::resize(factor)
}
#[inline]
fn try_coerce_metadata<O: Size>(
(): (),
) -> Option<<<[T] as Pointee>::Metadata as Packable>::Packed<O>> {
let factor = O::try_from_usize(N)?;
<[T]>::try_resize(factor)
}
}
macro_rules! non_zero_inner {
($from:ident, {$($to:ty),*}) => {
$(
#[doc = concat!("Defines the coercion for `", stringify!($from) ,"` to `", stringify!($to), "`.")]
///
/// # Examples
///
/// ```
#[doc = concat!("use std::num::", stringify!($from), ";")]
///
/// use musli_zerocopy::Ref;
///
#[doc = concat!("let reference: Ref<", stringify!($from), "> = Ref::zero();")]
#[doc = concat!("let reference2 = reference.coerce::<", stringify!($to), ">();")]
/// assert_eq!(reference.offset(), reference2.offset());
/// ```
impl Coerce<$to> for core::num::$from {
#[inline(always)]
fn coerce_metadata<O: Size>(metadata: ()) -> () {
metadata
}
#[inline(always)]
fn try_coerce_metadata<O: Size>(metadata: ()) -> Option<()> {
Some(metadata)
}
}
)*
}
}
macro_rules! non_zero {
([$({$($from:ident),*}),*], [$($to:tt),*]) => {
$(
$(
non_zero_inner!($from, $to);
)*
)*
};
}
non_zero!([{NonZeroU8, NonZeroI8}], [{u8, i8}]);
non_zero!([{NonZeroU16, NonZeroI16}], [{u16, i16}]);
non_zero!([{NonZeroU32, NonZeroI32}], [{u32, i32}]);
non_zero!([{NonZeroU64, NonZeroI64}], [{u64, i64}]);
non_zero!([{NonZeroU128, NonZeroI128}], [{u128, i128}]);
/// Defines the coercion for `core::num::Wrapping<T>` to `U`.
///
/// This is largely defined by the [`Coerce<T>`] of `T` to `U`.
///
/// # Examples
///
/// ```
/// use std::num::Wrapping;
///
/// use musli_zerocopy::Ref;
///
/// let reference: Ref<Wrapping<i128>> = Ref::zero();
/// let reference2 = reference.coerce::<u128>();
/// let reference3 = reference.coerce::<[u32; 4]>();
/// let reference4 = reference.coerce::<u128>().coerce::<[u32]>();
/// assert_eq!(reference4.len(), 4);
/// ```
impl<T, U> Coerce<U> for core::num::Wrapping<T>
where
T: Coerce<U>,
U: ZeroCopy,
T: ZeroCopy,
{
#[inline(always)]
fn coerce_metadata<O: Size>(metadata: ()) {
metadata
}
#[inline(always)]
fn try_coerce_metadata<O: Size>(metadata: ()) -> Option<()> {
Some(metadata)
}
}