rkyv 0.8.0-rc.2

//! Niched archived `Option<NonZero>` integers that use less space.

use core::{
    cmp, fmt, hash,
    num::{
        NonZeroI128, NonZeroI16, NonZeroI32, NonZeroI64, NonZeroI8,
        NonZeroU128, NonZeroU16, NonZeroU32, NonZeroU64, NonZeroU8,
    },
};

use munge::munge;

use crate::{seal::Seal, Archived, Place, Portable};

macro_rules! impl_archived_option_nonzero {
    ($ar:ident, $nz:ty, $ne:ty) => {
        #[doc = concat!("A niched archived `Option<", stringify!($nz), ">`")]
        #[derive(Copy, Clone, Portable)]
        #[rkyv(crate)]
        #[repr(transparent)]
        #[cfg_attr(feature = "bytecheck", derive(bytecheck::CheckBytes))]
        pub struct $ar {
            inner: Archived<$ne>,
        }

        impl $ar {
            /// Returns `true` if the option is a `None` value.
            #[inline]
            pub fn is_none(&self) -> bool {
                self.inner == 0
            }

            /// Returns `true` if the option is a `Some` value.
            #[inline]
            pub fn is_some(&self) -> bool {
                self.inner != 0
            }

            #[rustfmt::skip]
            #[doc = concat!(
                "Converts to an `Option<&Archived<",
                stringify!($nz),
                ">>`"
            )]
            #[inline]
            pub fn as_ref(&self) -> Option<&Archived<$nz>> {
                if self.inner != 0 {
                    let as_nonzero = unsafe {
                        // SAFETY: NonZero types have the same memory layout and
                        // bit patterns as their integer counterparts,
                        // regardless of endianness.
                        &*(&self.inner as *const _ as *const Archived<$nz>)
                    };
                    Some(as_nonzero)
                } else {
                    None
                }
            }

            #[rustfmt::skip]
            #[doc = concat!(
                "Converts to an `Option<&mut Archived<",
                stringify!($nz),
                ">>`",
            )]
            #[inline]
            pub fn as_mut(&mut self) -> Option<&mut Archived<$nz>> {
                if self.inner != 0 {
                    let as_nonzero = unsafe {
                        // SAFETY: NonZero types have the same memory layout and
                        // bit patterns as their integer counterparts,
                        // regardless of endianness.
                        &mut *(&mut self.inner as *mut _ as *mut Archived<$nz>)
                    };
                    Some(as_nonzero)
                } else {
                    None
                }
            }

            #[rustfmt::skip]
            #[doc = concat!(
                "Converts from `Seal<'_, ArchivedOption",
                stringify!($nz),
                ">` to `Option<Seal<'_, Archived<",
                stringify!($nz),
                ">>>`.",
            )]
            #[inline]
            pub fn as_seal(
                this: Seal<'_, Self>,
            ) -> Option<Seal<'_, Archived<$nz>>> {
                let this = unsafe { Seal::unseal_unchecked(this) };
                this.as_mut().map(Seal::new)
            }

            /// Takes the value out of the option, leaving a `None` in its
            /// place.
            #[inline]
            pub fn take(&mut self) -> Option<Archived<$nz>> {
                if self.inner != 0 {
                    // SAFETY: self.inner is nonzero
                    let result = unsafe {
                        Archived::<$nz>::new_unchecked(self.inner.into())
                    };
                    self.inner = 0.into();
                    Some(result)
                } else {
                    None
                }
            }

            /// Returns an iterator over the possibly-contained value.
            #[inline]
            pub fn iter(&self) -> Iter<&'_ Archived<$nz>> {
                Iter::new(self.as_ref())
            }

            /// Returns an iterator over the mutable possibly-contained value.
            #[inline]
            pub fn iter_mut(&mut self) -> Iter<&'_ mut Archived<$nz>> {
                Iter::new(self.as_mut())
            }

            /// Returns an iterator over the sealed mutable possibly-contained
            /// value.
            #[inline]
            pub fn iter_seal(
                this: Seal<'_, Self>,
            ) -> Iter<Seal<'_, Archived<$nz>>> {
                Iter::new(Self::as_seal(this))
            }

            /// Inserts `v` into the option if it is `None`, then returns a
            /// mutable reference to the contained value.
            #[inline]
            pub fn get_or_insert(&mut self, v: $nz) -> &mut Archived<$nz> {
                self.get_or_insert_with(move || v)
            }

            /// Inserts a value computed from `f` into the option if it is
            /// `None`, then returns a mutable reference to the contained value.
            pub fn get_or_insert_with<F>(&mut self, f: F) -> &mut Archived<$nz>
            where
                F: FnOnce() -> $nz,
            {
                if self.inner == 0 {
                    self.inner = f().get().into();
                }
                unsafe {
                    // SAFETY: self.inner is nonzero
                    &mut *(&mut self.inner as *mut _ as *mut Archived<$nz>)
                }
            }

            /// Resolves an `ArchivedOptionNonZero` from an `Option<NonZero>`.
            #[inline]
            pub fn resolve_from_option(
                field: Option<$nz>,
                out: Place<Self>,
            ) {
                munge!(let Self { inner } = out);
                if let Some(nz) = field {
                    inner.write(nz.get().into());
                } else {
                    inner.write((0 as $ne).into());
                }
            }
        }

        impl fmt::Debug for $ar {
            #[inline]
            fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
                self.as_ref().fmt(f)
            }
        }

        impl Eq for $ar {}

        impl hash::Hash for $ar {
            fn hash<H: hash::Hasher>(&self, state: &mut H) {
                self.as_ref().hash(state)
            }
        }

        impl Ord for $ar {
            #[inline]
            fn cmp(&self, other: &Self) -> cmp::Ordering {
                self.as_ref().cmp(&other.as_ref())
            }
        }

        impl PartialEq for $ar {
            #[inline]
            fn eq(&self, other: &Self) -> bool {
                self.as_ref().eq(&other.as_ref())
            }
        }

        impl PartialOrd for $ar {
            #[inline]
            fn partial_cmp(&self, other: &Self) -> Option<cmp::Ordering> {
                Some(self.cmp(other))
            }
        }
    };
}

impl_archived_option_nonzero!(ArchivedOptionNonZeroI8, NonZeroI8, i8);
impl_archived_option_nonzero!(ArchivedOptionNonZeroI16, NonZeroI16, i16);
impl_archived_option_nonzero!(ArchivedOptionNonZeroI32, NonZeroI32, i32);
impl_archived_option_nonzero!(ArchivedOptionNonZeroI64, NonZeroI64, i64);
impl_archived_option_nonzero!(ArchivedOptionNonZeroI128, NonZeroI128, i128);

/// A niched archived `Option<NonZeroIsize>`
pub type ArchivedOptionNonZeroIsize = match_pointer_width!(
    ArchivedOptionNonZeroI16,
    ArchivedOptionNonZeroI32,
    ArchivedOptionNonZeroI64,
);

impl_archived_option_nonzero!(ArchivedOptionNonZeroU8, NonZeroU8, u8);
impl_archived_option_nonzero!(ArchivedOptionNonZeroU16, NonZeroU16, u16);
impl_archived_option_nonzero!(ArchivedOptionNonZeroU32, NonZeroU32, u32);
impl_archived_option_nonzero!(ArchivedOptionNonZeroU64, NonZeroU64, u64);
impl_archived_option_nonzero!(ArchivedOptionNonZeroU128, NonZeroU128, u128);

/// A niched archived `Option<NonZeroUsize>`
pub type ArchivedOptionNonZeroUsize = match_pointer_width!(
    ArchivedOptionNonZeroU16,
    ArchivedOptionNonZeroU32,
    ArchivedOptionNonZeroU64,
);

/// An iterator over a reference to the `Some` variant of an
/// `ArchivedOptionNonZero` integer.
///
/// This iterator yields one value if the `ArchivedOptionNonZero` integer is a
/// `Some`, otherwise none.
pub type Iter<P> = crate::option::Iter<P>;