Struct rkyv::validation::validators::ArchiveValidator

pub struct ArchiveValidator<'a> { /* private fields */ }

A validator that can verify archives with nonlocal memory.

Implementations

impl<'a> ArchiveValidator<'a>

pub fn new(bytes: &'a [u8]) -> Self

Creates a new bounds validator for the given bytes.

pub fn with_max_depth(bytes: &'a [u8], max_subtree_depth: usize) -> Self

Crates a new bounds validator for the given bytes with a maximum validation depth.

pub fn log_alignment(&self) -> usize

Returns the log base 2 of the alignment of the archive.

An archive that is 2-aligned will return 1, 4-aligned will return 2, 8-aligned will return 3 and so on.

pub fn alignment(&self) -> usize

Returns the alignment of the archive.

Trait Implementations

impl<'a> ArchiveContext for ArchiveValidator<'a>

type PrefixRange = PrefixRange

A prefix range from an archive context.

type SuffixRange = SuffixRange

A suffix range from an archive context.

unsafe fn bounds_check_ptr(
    &mut self,
    base: *const u8,
    offset: isize
) -> Result<*const u8, Self::Error>

Checks that a relative pointer points to an address within the archive.

unsafe fn bounds_check_layout(
    &mut self,
    data_address: *const u8,
    layout: &Layout
) -> Result<(), Self::Error>

Checks that a given pointer can be dereferenced.

unsafe fn bounds_check_subtree_ptr_layout(
    &mut self,
    data_address: *const u8,
    layout: &Layout
) -> Result<(), Self::Error>

Checks that the given data address and layout is located completely within the subtree range.

unsafe fn push_prefix_subtree_range(
    &mut self,
    root: *const u8,
    end: *const u8
) -> Result<PrefixRange, Self::Error>

Pushes a new subtree range onto the validator and starts validating it.

fn pop_prefix_range(&mut self, range: PrefixRange) -> Result<(), Self::Error>

Pops the given range, restoring the original state with the pushed range removed.

unsafe fn push_suffix_subtree_range(
    &mut self,
    start: *const u8,
    root: *const u8
) -> Result<SuffixRange, Self::Error>

Pushes a new subtree range onto the validator and starts validating it.

fn pop_suffix_range(&mut self, range: SuffixRange) -> Result<(), Self::Error>

Finishes the given range, restoring the original state with the pushed range removed.

fn finish(&mut self) -> Result<(), Self::Error>

Verifies that all outstanding claims have been returned.

unsafe fn check_ptr<T: LayoutRaw + Pointee + ?Sized>(
    &mut self,
    base: *const u8,
    offset: isize,
    metadata: T::Metadata
) -> Result<*const T, Self::Error>

Checks that the given relative pointer can be dereferenced.

unsafe fn check_rel_ptr<T: ArchivePointee + LayoutRaw + ?Sized>(
    &mut self,
    rel_ptr: &RelPtr<T>
) -> Result<*const T, Self::Error>

Checks that the given RelPtr can be dereferenced.

unsafe fn bounds_check_subtree_ptr<T: LayoutRaw + ?Sized>(
    &mut self,
    ptr: *const T
) -> Result<(), Self::Error>

Checks that the given pointer is located completely within the subtree range.

unsafe fn check_subtree_ptr<T: LayoutRaw + Pointee + ?Sized>(
    &mut self,
    base: *const u8,
    offset: isize,
    metadata: T::Metadata
) -> Result<*const T, Self::Error>

Checks that the given relative pointer to a subtree can be dereferenced.

unsafe fn check_subtree_rel_ptr<T: ArchivePointee + LayoutRaw + ?Sized>(
    &mut self,
    rel_ptr: &RelPtr<T>
) -> Result<*const T, Self::Error>

Checks that the given RelPtr to a subtree can be dereferenced.

unsafe fn push_prefix_subtree<T: LayoutRaw + ?Sized>(
    &mut self,
    root: *const T
) -> Result<Self::PrefixRange, Self::Error>

Pushes a new subtree range onto the validator and starts validating it.

impl<'a> Debug for ArchiveValidator<'a>

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

Formats the value using the given formatter.

impl<'a> Fallible for ArchiveValidator<'a>

type Error = ArchiveError

The error produced by any failing methods.

impl<'a> Send for ArchiveValidator<'a>

impl<'a> Sync for ArchiveValidator<'a>