Struct RelativePtr 

pub struct RelativePtr<T, const ALIGN: usize, E: Endian = NativeEndian> { /* private fields */ }

Available on (crate features alloc or std or derive or serde or zero-copy or static-size) and crate feature zero-copy only.

A relative pointer that stores the offset from its own address to the target data. This allows zero-copy deserialization without runtime allocations.

Implementations

impl<T, const ALIGN: usize, E: Endian> RelativePtr<T, ALIGN, E>

pub fn new(offset: i32) -> Self

Creates a new RelativePtr with the given native offset.

pub fn get<'a>(&self, buffer: &'a [u8]) -> Option<&'a T>

where T: ZeroCopy,

Resolves the pointer within the given buffer. Returns Some(&T) if the computed pointer is within the bounds of buffer and correctly aligned. Otherwise, returns None.

Trait Implementations

impl<'a, T, const ALIGN: usize, E: Endian> Arbitrary<'a> for RelativePtr<T, ALIGN, E>

Available on crate feature fuzzing only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl<'de, T: StaticSize, const ALIGN: usize, E: Endian, Context> BorrowDecode<'de, Context> for RelativePtr<T, ALIGN, E>

fn borrow_decode<D: BorrowDecoder<'de, Context = Context>>( decoder: &mut D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given [BorrowDecode].

impl<T: Clone, const ALIGN: usize, E: Clone + Endian> Clone for RelativePtr<T, ALIGN, E>

fn clone(&self) -> RelativePtr<T, ALIGN, E>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, const ALIGN: usize, E: Debug + Endian> Debug for RelativePtr<T, ALIGN, E>

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

Formats the value using the given formatter.

impl<T: StaticSize, const ALIGN: usize, E: Endian, Context> Decode<Context> for RelativePtr<T, ALIGN, E>

fn decode<D: Decoder<Context = Context>>( decoder: &mut D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given [Decode].

impl<T: ZeroCopy + DeepValidator, const ALIGN: usize, E: Endian> DeepValidator for RelativePtr<T, ALIGN, E>

fn is_valid_deep(&self, buffer: &[u8]) -> bool

Performs a deep validation check on the relative pointer.

impl<T: StaticSize, const ALIGN: usize, E: Endian> Encode for RelativePtr<T, ALIGN, E>

fn encode<EN: Encoder>(&self, encoder: &mut EN) -> Result<(), EncodeError>

Encode a given type.

impl<T: PartialEq, const ALIGN: usize, E: PartialEq + Endian> PartialEq for RelativePtr<T, ALIGN, E>

fn eq(&self, other: &RelativePtr<T, ALIGN, E>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, const ALIGN: usize, E: Endian> StaticSize for RelativePtr<T, ALIGN, E>

const SIZE: usize

The size of the type in bytes.

impl<T: ZeroCopy, const ALIGN: usize, E: Endian> Validator for RelativePtr<T, ALIGN, E>

fn is_valid(&self, buffer: &[u8]) -> bool

Checks if the relative pointer is valid within the given buffer.

impl<T, const ALIGN: usize, E: Endian> ZeroCopy for RelativePtr<T, ALIGN, E>

const ALIGN: usize

The required alignment for this type.

impl<E: Endian, T, const ALIGN: usize> ZeroCopyType<E> for RelativePtr<T, ALIGN, E>

where T: ZeroCopy + ZeroCopyType<E>,

Available on crate feature alloc only.

type Builder = RelativeBuilder<<T as ZeroCopyType<E>>::Builder, ALIGN>

The builder type associated with this trait.

impl<T: Copy, const ALIGN: usize, E: Copy + Endian> Copy for RelativePtr<T, ALIGN, E>

impl<T: Eq, const ALIGN: usize, E: Eq + Endian> Eq for RelativePtr<T, ALIGN, E>

impl<T, const ALIGN: usize, E: Endian> StructuralPartialEq for RelativePtr<T, ALIGN, E>