packed_ptr 0.1.2

A configurable & generic tagged pointer implementation in Rust
Documentation 
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

use core::fmt::{Debug, Display, Formatter};

/// Error type for [`PackedPtr::new`] & [`TypedPackedPtr::new`].
///
/// [`PackedPtr::new`]: crate::PackedPtr::new
/// [`TypedPackedPtr::new`]: crate::TypedPackedPtr::new
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
pub enum PackedPtrError {
    /// The address is not aligned to the required alignment.
    UnalignedAddress,
    /// The data is too large to pack into the pointer.
    DataOverflow,
    /// The provided [`PtrCfg`](crate::config::PtrCfg) would result in UB if used with
    /// provided pointer.
    UnsafeConfig,
}

impl Display for PackedPtrError {
    fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
        match *self {
            Self::UnalignedAddress => f.write_str("unaligned address"),
            Self::DataOverflow => f.write_str("data too large"),
            Self::UnsafeConfig => f.write_str("unsafe config"),
        }
    }
}

#[cfg(feature = "std")]
impl std::error::Error for PackedPtrError {}