rep 0.3.0

A small tool for representation/class invariants
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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

//! Rep is a small tool for checking representation/class invariants

pub use rep_derive::*;
pub use rep_derive::check_rep;
pub use log::Level::Error;
pub use log::{error, log_enabled};

/// A trait for representation checking
pub trait CheckRep {
	/// Returns true if representation is correct, false otherwise
    fn is_correct(&self) -> bool {
    	self.correctness().is_ok()
    }

    /// Returns Ok if representation is correct, vector of errors otherwise
    fn correctness(&self) -> Result<(), Vec<String>> {
    	if self.is_correct() {
    		Ok(())
    	} else {
    		Err(vec![])
    	}
    }

    /// Asserts that self is correct
	fn check_rep(&self) {
		match self.correctness() {
			Ok(_) => {}
			Err(errors) => {
				if log_enabled!(Error) {
					for error in errors {
						error!("representation invariant violated: {:?}", error);
					}
				} else {
					if errors.len() > 0 {
						panic!("representation invariant violated: {:?}", errors);	
					} else {
						panic!("representation invariant violated");	
					}
				}
			}
		}
	}
}

/// A trait for adding extra rep-checking functionality to a data structure with `CheckRep` implemented
pub trait CustomCheckRep {
	/// Returns true if representation is correct, false otherwise
    fn c_is_correct(&self) -> bool {
    	self.c_correctness().is_ok()
    }

    /// Returns Ok if representation is correct, vector of errors otherwise
    fn c_correctness(&self) -> Result<(), Vec<String>> {
    	if self.c_is_correct() {
    		Ok(())
    	} else {
    		Err(vec![])
    	}
    }
}