Struct Check 

pub struct Check { /* private fields */ }

A validation check containing one or more constraints.

A Check groups related constraints together and assigns them a severity level. Checks are the building blocks of validation suites. When a check runs, all its constraints are evaluated, and the check fails if any constraint fails.

Examples

Basic Check

use term_guard::core::{Check, Level};

let check = Check::builder("user_data_quality")
    .level(Level::Error)
    .description("Validates user data quality")
    .build();

Check with Constraints

use term_guard::core::{Check, Level, ConstraintOptions};
use term_guard::constraints::{Assertion, UniquenessType, StatisticType, FormatType, FormatOptions};

let check = Check::builder("customer_validation")
    .level(Level::Error)
    .description("Ensure customer data integrity")
    // Completeness checks using unified API
    .completeness("customer_id", ConstraintOptions::new().with_threshold(1.0))
    .completeness("email", ConstraintOptions::new().with_threshold(0.99))
    // Uniqueness checks using unified API
    .validates_uniqueness(vec!["customer_id"], 1.0)
    .validates_uniqueness(vec!["email", "region"], 1.0)
    // Pattern validation using format
    .has_format("phone", FormatType::Regex(r"^\+?\d{3}-\d{3}-\d{4}$".to_string()), 0.95, FormatOptions::default())
    // Range checks using statistic
    .statistic("age", StatisticType::Min, Assertion::GreaterThanOrEqual(18.0))
    .statistic("age", StatisticType::Max, Assertion::LessThanOrEqual(120.0))
    .build();

Data Quality Check

use term_guard::core::{Check, Level};
use term_guard::constraints::{Assertion, StatisticType};

let check = Check::builder("data_types_and_formats")
    .level(Level::Warning)
    // Ensure consistent data types using the unified API
    .has_consistent_data_type("order_date", 0.99)
    .has_consistent_data_type("product_id", 0.95)
    // String length validation
    .has_min_length("password", 8)
    .has_max_length("username", 20)
    // Check for PII
    .validates_credit_card("comments", 0.0, true)  // Should be 0%
    .validates_email("email_field", 0.98)
    // Statistical checks
    .statistic("order_value", StatisticType::Mean, Assertion::Between(50.0, 500.0))
    .statistic("response_time", StatisticType::StandardDeviation, Assertion::LessThan(100.0))
    .build();

Enhanced Format Validation

use term_guard::core::{Check, Level};
use term_guard::constraints::FormatOptions;

let check = Check::builder("enhanced_format_validation")
    .level(Level::Error)
    // Basic format validation
    .validates_email("email", 0.95)
    .validates_url("website", 0.90, false)
    .validates_phone("phone", 0.85, Some("US"))
    // Enhanced format validation with options
    .validates_email_with_options(
        "secondary_email",
        0.80,
        FormatOptions::lenient()  // Case insensitive, trimming, nulls allowed
    )
    .validates_url_with_options(
        "dev_url",
        0.75,
        true, // allow localhost
        FormatOptions::case_insensitive().trim_before_check(true)
    )
    .validates_regex_with_options(
        "product_code",
        r"^[A-Z]{2}\d{4}$",
        0.98,
        FormatOptions::strict()  // Case sensitive, no nulls, no trimming
    )
    .build();

Implementations

impl Check

pub fn builder(name: impl Into<String>) -> CheckBuilder

Creates a new builder for constructing a check.

Arguments

• name - The name of the check

Examples

use term_guard::core::Check;

let builder = Check::builder("data_quality");

pub fn name(&self) -> &str

Returns the name of the check.

pub fn level(&self) -> Level

Returns the severity level of the check.

pub fn description(&self) -> Option<&str>

Returns the description of the check if available.

pub fn constraints(&self) -> &[Arc<dyn Constraint>]

Returns the constraints in this check.

Trait Implementations

impl CheckMultiTableExt for Check

fn multi_table(name: impl Into<String>) -> MultiTableCheck

Create a multi-table validation check.

impl Clone for Check

fn clone(&self) -> Check

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Check

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.