Crate specler

Specler

A simple library for defining and validating specifications on your types. This solves an issue with other validation approaches where it is possible to first create a type and then verify its validity. In disagreeing with this approach, a solution was needed to verify specifications in factory methods.

Concepts

A specification defines a list of requirements that a type must meet. These requirements are expressed as a list of validators, which are simple functions returning a ValidatorResult. These then get compiled into a single SpecValidationResult.

Examples

Validating using an empty spec

use crate::specler::core::require::Require;
use crate::specler::core::spec_error::SpecError;

let spec = Require::<String>::to();
let result = spec.validate("");

assert!(result.is_ok());

Validating a string to not be empty

use specler::{assert_spec_error_msg};
use specler::core::require::Require;
use specler::specs::string::not_empty;
use crate::specler::core::spec_error::SpecError;

let spec = Require::<String>::to().be(not_empty());
let result = spec.validate("");

assert!(result.is_err());
assert_spec_error_msg!(result, "cannot be empty");

Validating the length of a string

use specler::core::require::Require;
use specler::specs::string::{no_longer_than, no_shorter_than};
let spec = Require::<String>::to()
    .be(no_longer_than(4))
    .be(no_shorter_than(2));
let result = spec.validate("abc");;

assert!(result.is_ok());

Validating a string to match a pattern

let spec = Require::<String>::to()
   .be(matching(r"^[a-zA-Z]+$"));
let result = spec.validate("oops123");

assert!(!result.is_ok());
assert_spec_error_msg!(result, "does not match the pattern '^[a-zA-Z]+$'");

Modules

• core
  Core module containing core functionality, excluding concrete type specifications
• prelude
  A prelude module re-exports commonly used items and is re-exported in the library’s root
• specs
  Module containing core specifications for standard types, e.g. String

Macros

• assert_spec_error_msg
  Asserts that a SpecValidationResult is invalid and contains the expected error
• assert_spec_invalid
  Asserts that a SpecValidationResult is valid Asserts that a SpecValidationResult is invalid