anodized 0.4.0

An ecosystem for correct Rust based on lightweight specification annotations
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

use anodized::spec;

#[derive(Debug, PartialEq, Eq)]
#[allow(dead_code)]
enum State {
    Idle,
    Running,
    Finished,
}

struct Job {
    state: State,
}

impl Job {
    #[spec(
        requires: matches!(self.state, State::Idle),
        maintains: matches!(self.state, State::Idle | State::Running | State::Finished),
        ensures: matches!(self.state, State::Running),
    )]
    fn start(&mut self) {
        self.state = State::Running;
    }
}

#[test]
fn job_start_success() {
    let mut job = Job { state: State::Idle };
    job.start();
}

#[cfg(feature = "runtime-check-and-panic")]
#[test]
#[should_panic(expected = "Precondition failed: matches! (self.state, State::Idle)")]
fn job_start_panics_if_not_idle() {
    let mut job = Job {
        state: State::Running,
    };
    job.start(); // This violates the precondition.
}