fj_core/validation/
mod.rs

1//! # Infrastructure for validating objects
2//!
3//! ## Nomenclature
4//!
5//! **Validation** is the process of checking that objects meet specific
6//! requirements. Each kind of object has its own set of requirements.
7//!
8//! An object that meets all the requirement for its kind is considered
9//! **valid**. An object that does not meet all of them is considered
10//! **invalid**. This results in a **validation error**, which is represented by
11//! [`ValidationError`].
12//!
13//! ## Implementation Note
14//!
15//! This is a new module whose goal is to replace [`crate::validate`]. While
16//! this transition is ongoing, both modules will be incomplete.
17//!
18//! Issues that track the transition:
19//!
20//! - <https://github.com/hannobraun/fornjot/issues/1713>
21//! - <https://github.com/hannobraun/fornjot/issues/2157>
22
23mod config;
24mod error;
25mod validation;
26mod validation_check;
27
28pub mod checks;
29
30pub use self::{
31    config::ValidationConfig,
32    error::{ValidationError, ValidationErrors},
33    validation::Validation,
34    validation_check::ValidationCheck,
35};