5 releases

0.2.4 Dec 31, 2023
0.2.3 Dec 3, 2023
0.1.1 Dec 2, 2023

#311 in Data structures

Download history 2789/week @ 2024-10-03 5615/week @ 2024-10-10 3246/week @ 2024-10-17 3585/week @ 2024-10-24 3748/week @ 2024-10-31 4353/week @ 2024-11-07 3715/week @ 2024-11-14 4717/week @ 2024-11-21 4495/week @ 2024-11-28 4223/week @ 2024-12-05 4283/week @ 2024-12-12 5075/week @ 2024-12-19 3923/week @ 2024-12-26 6091/week @ 2025-01-02 4436/week @ 2025-01-09 3074/week @ 2025-01-16

18,734 downloads per month
Used in 13 crates (via openraft)

MIT/Apache

37KB
943 lines

validit

Discord Chat Crates.io docs.rs Crates.io Crates.io

Validate variable internal state when the variable is accessed.

  • Implement trait Validate for a type T to define how to validate internal state of T.
  • Wrapper struct Valid<T: Validate> implements Deref and DerefMut traits, and validates the internal state when the variable is accessed.

For example, If in your program you have a struct Foo(u64) and you want to make sure that a is always less than to 5, you can implement Validate trait for Foo and use less! macro to validate a.

struct Foo(u64);

impl validit::Validate for Foo {
  fn validate(&self) -> Result<(), Box<dyn std::error::Error>> {
    validit::less!(self.0, 5);
    Ok(())
  }
}

fn main() {
  let v1 = Valid::new(Foo(1));
  let _x = v1.0; // Good.

  let v6 = Foo(6);
  let _x = v6.0; // No panic without validation.
  
  let v6 = Valid::new(Foo(6));
  let _x = v6.0; // panic: panicked at 'invalid state: expect: self.0(6) < 5(5) ...
}

Contribution

Dependencies

~0–5.5MB
~14K SLoC