Struct PackedRef 

pub struct PackedRef<'a, T, C: PtrCfg, D: Packable>(/* private fields */);

A type safe reference to a packed pointer.

Equivalent to &T where T is the type of the pointer.

Implementations

impl<'a, T, C: PtrCfg, D: Packable> PackedRef<'a, T, C, D>

pub fn new(ptr: &'a T, data: D, cfg: C) -> Result<Self, PackedPtrError>

Creates a new PackedRef from a reference and some data.

Errors

• PackedPtrError::DataOverflow if the data is too large to fit in the pointer.
• PackedPtrError::UnsafeConfig if the pointer is not compatible with the configuration.

pub unsafe fn new_unchecked(ptr: &'a T, data: D) -> Self

Creates a new PackedRef from a reference and some data without performing any safety checks.

Safety

This function is unsafe because the caller assumes the responsibility of ensuring that the provided ptr and data are valid and that they are compatible with the configuration.

References are always aligned, therefore ptr should always be valid, but if the ptr of the system is incompatible with the configuration, then the reference will be corrupted, resulting in UB.

Also, if the data is too big to fit in the pointer, undefined behavior may occur.

Arguments

• ptr: A reference to a T
• data: The data to be packed into the pointer.

Returns

A new PackedRef with the given ptr and data.

pub fn data(self) -> D

Returns the packed data value of the Packed Pointer.

pub fn get(self) -> (&'a T, D)

Returns a tuple containing the reference and the packed data value.

pub fn set_data(&mut self, data: D)

Sets the packed data value of the pointer.

Arguments

• data: The data to pack into the pointer.

Trait Implementations

impl<T, C: PtrCfg, D: Packable> Clone for PackedRef<'_, T, C, D>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug, C: PtrCfg, D: Packable + Debug> Debug for PackedRef<'_, T, C, D>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T, C: PtrCfg, D: Packable> Deref for PackedRef<'_, T, C, D>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T, C: PtrCfg, D: Packable> Pointer for PackedRef<'_, T, C, D>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T, C: PtrCfg, D: Packable> Copy for PackedRef<'_, T, C, D>