Struct checkers::Machine

pub struct Machine {
    pub memory_used: usize,
    // some fields omitted
}

Fake machine implementation to validate an allocation history.

Fields

memory_used: usize

Current memory used according to allocations.

Methods

impl Machine

pub fn push(&mut self, event: Event) -> Result<(), Violation>

Push an event into the machine.

Examples

Checks for a double-free:

use checkers::{Event::*, Region, Machine};

let mut machine = Machine::default();

assert!(machine.push(Alloc(Region::new(0.into(), 2, 1))).is_ok());
assert!(machine.push(Free(Region::new(0.into(), 2, 1))).is_ok());
assert!(machine.push(Free(Region::new(0.into(), 2, 1))).is_err());

Check for a misaligned allocation:

use checkers::{Event::*, Region, Machine, Violation};

let mut machine = Machine::default();
let requested = Region::new(5.into(), 2, 4);

assert_eq!(
    Err(Violation::MisalignedAlloc { requested }),
    machine.push(Alloc(requested))
);

Tries to deallocate part of other region:

use checkers::{Event::*, Region, Machine, Violation};

let mut machine = Machine::default();
let existing = Region::new(100.into(), 100, 1);

assert!(machine.push(Alloc(existing)).is_ok());

let requested = Region::new(150.into(), 50, 1);
assert_eq!(
    Err(Violation::MissingFree { requested }),
    machine.push(Free(requested))
);

let requested = Region::new(100.into(), 50, 1);
assert_eq!(
    Err(Violation::IncompleteFree { requested, existing }),
    machine.push(Free(requested))
);

pub fn trailing_regions(&self) -> Vec<Region>

Access all trailing regions (ones which have not been deallocated).

Trait Implementations

impl Default for Machine

fn default() -> Machine

Returns the "default value" for a type.