Enum checkers::Event

#[non_exhaustive]pub enum Event {
    Alloc(Region),
    Free(Region),
    AllocZeroed(AllocZeroed),
    Realloc(Realloc),
    AllocFailed,
    AllocZeroedFailed,
    ReallocNull,
    ReallocFailed,
}

Metadata for a single allocation or deallocation.

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.

Alloc(Region)

An allocation.

Free(Region)

A deallocation.

AllocZeroed(AllocZeroed)

A zerod allocation, with an optional boolean indicates if it is actually zeroed or not.

Realloc(Realloc)

A reallocation that moves and resized memory from one location to another.

AllocFailed

An allocation failed (produced null).

AllocZeroedFailed

A zero allocation that failed (produced null).

ReallocNull

Allocator was asked to reallocate unallocated memory.

ReallocFailed

A reallocation failed (produced null), and the previous region is left unchanged.

Implementations

impl Event

pub fn is_alloc_with<F>(self, f: F) -> bool where
    F: FnOnce(Region) -> bool, 

Test if this event is an allocation which matches the specified predicate.

Examples

let event = checkers::Event::Alloc(checkers::Region::new(100.into(), 100, 4));

assert!(event.is_alloc_with(|r| r.size == 100 && r.align == 4));
assert!(!event.is_free_with(|r| r.size == 100 && r.align == 4));

pub fn is_free_with<F>(self, f: F) -> bool where
    F: FnOnce(Region) -> bool, 

Test if this event is a deallocation which matches the specified predicate.

Examples

let event = checkers::Event::Free(checkers::Region::new(100.into(), 100, 4));

assert!(!event.is_alloc_with(|r| r.size == 100 && r.align == 4));
assert!(event.is_free_with(|r| r.size == 100 && r.align == 4));

pub fn is_alloc_zeroed_with<F>(self, f: F) -> bool where
    F: FnOnce(AllocZeroed) -> bool, 

Test if this event is an allocation which matches the specified predicate.

Examples

use checkers::{Event, Region, AllocZeroed};
let event = Event::AllocZeroed(AllocZeroed::new(Some(true), Region::new(100.into(), 100, 4)));

assert!(event.is_alloc_zeroed_with(|r| r.alloc.size == 100 && r.alloc.align == 4));
assert!(!event.is_free_with(|r| r.size == 100 && r.align == 4));

pub fn is_realloc_with<F>(self, f: F) -> bool where
    F: FnOnce(Realloc) -> bool, 

Test if this event is an allocation which matches the specified predicate.

Examples

use checkers::{Event, Region, Realloc};

let event = Event::Realloc(Realloc::new(
    Some(true),
    Region::new(10.into(), 10, 1),
    Region::new(20.into(), 20, 1)
));

assert!(event.is_realloc_with(|r| r.free.size == 10 && r.alloc.size == 20));

pub fn is_failed(self) -> bool

Test if this event is an allocation which matches the specified predicate.

Examples

use checkers::Event;

assert!(Event::AllocFailed.is_failed());
assert!(Event::AllocZeroedFailed.is_failed());
assert!(Event::ReallocFailed.is_failed());

Trait Implementations

impl Clone for Event

pub fn clone(&self) -> Event

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Event

impl Debug for Event

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

Formats the value using the given formatter.

impl Eq for Event

impl Hash for Event

pub fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Event

pub fn cmp(&self, other: &Event) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Event> for Event

pub fn eq(&self, other: &Event) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Event> for Event

pub fn partial_cmp(&self, other: &Event) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &Event) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &Event) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

pub fn gt(&self, other: &Event) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &Event) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Event

impl StructuralPartialEq for Event