Enum checkers::Violation

#[non_exhaustive]
pub enum Violation {
    ConflictingAlloc {
        request: Request,
        existing: Request,
    },
    NonZeroedAlloc {
        alloc: Request,
    },
    NonCopiedRealloc {
        realloc: Realloc,
    },
    ReallocNull {
        realloc: ReallocNull,
    },
    MisalignedAlloc {
        alloc: Request,
    },
    IncompleteFree {
        request: Request,
        existing: Request,
    },
    MisalignedFree {
        request: Request,
        existing: Request,
    },
    MissingFree {
        request: Request,
    },
    Leaked {
        alloc: Request,
    },
}

A single violation in the variants enforced by checkers.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ConflictingAlloc

Fields

request: Request

The allocated region.

existing: Request

The existing region.

A region produced by the allocator requested, overlaps with at least on existing allocation.

NonZeroedAlloc

Fields

alloc: Request

The allocated region.

A region produced by the allocator requested was not zeroed as expected.

NonCopiedRealloc

Fields

realloc: Realloc

The reallocation.

A region reallocatoed by the allocator was not copied appropriately. Meaning, the prefixing bytes between free and alloc do not match.

ReallocNull

Fields

realloc: ReallocNull

The null relocation.

Allocator was asked to reallocate a null pointer.

MisalignedAlloc

Fields

alloc: Request

The allocated region.

A region produced by the allocator requested was not aligned appropriately.

IncompleteFree

Fields

request: Request

The freed region.

existing: Request

The existing region.

A freed region requested only freed part of at least one other region existing.

MisalignedFree

Fields

request: Request

The freed region.

existing: Request

The existing region.

A freed region requested provided the wrong alignment metadata. See std::alloc::Layout::align.

MissingFree

Fields

request: Request

The freed region.

A freed region requested was not allocated at the time it was freed.

Leaked

Fields

alloc: Request

The leaked region.

A region was leaked. In that it was allocated but never freed.

Implementations

impl Violation

A single violation to the virtual memory model of checkers.

pub fn is_leaked_with<F>(&self, f: F) -> boolwhere F: FnOnce(Region) -> bool,

Test that this violation refers to a dangling region and that it matches the given predicate.

Examples

let alloc = Request::without_backtrace(Region::new(42.into(), 20, 4));
let violation = Violation::Leaked { alloc };
assert!(violation.is_leaked_with(|r| r.size == 20 && r.align == 4));

let alloc = Request::without_backtrace(Region::new(10.into(), 10, 1));
let violation = Violation::MisalignedAlloc { alloc };
assert!(!violation.is_leaked_with(|r| true));

Trait Implementations

impl Clone for Violation

fn clone(&self) -> Violation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Violation

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

Formats the value using the given formatter.

impl Display for Violation

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

Formats the value using the given formatter.