Struct FormatConstraint 

pub struct FormatConstraint { /* private fields */ }

A unified constraint that validates data formats and patterns.

This constraint replaces individual format constraints (PatternConstraint, EmailConstraint, UrlConstraint, CreditCardConstraint) and adds support for many additional formats.

Examples

use term_guard::constraints::{FormatConstraint, FormatType, FormatOptions};
use term_guard::core::Constraint;

// Email validation
let email_constraint = FormatConstraint::new(
    "email",
    FormatType::Email,
    0.95,
    FormatOptions::default()
).unwrap();

// Phone number validation for US
let phone_constraint = FormatConstraint::new(
    "phone",
    FormatType::Phone { country: Some("US".to_string()) },
    0.90,
    FormatOptions::new().trim_before_check(true)
).unwrap();

// Custom regex pattern
let code_constraint = FormatConstraint::new(
    "product_code",
    FormatType::Regex(r"^[A-Z]{2}\d{4}$".to_string()),
    1.0,
    FormatOptions::default()
).unwrap();

Implementations

impl FormatConstraint

pub fn new( column: impl Into<String>, format: FormatType, threshold: f64, options: FormatOptions, ) -> Result<Self>

Creates a new format constraint.

Arguments

• column - The column to check
• format - The format type to validate
• threshold - The minimum ratio of values that must match (0.0 to 1.0)
• options - Format validation options

Errors

Returns error if column name is invalid or threshold is out of range

pub fn email(column: impl Into<String>, threshold: f64) -> Result<Self>

Creates a format constraint for email validation.

pub fn url( column: impl Into<String>, threshold: f64, allow_localhost: bool, ) -> Result<Self>

Creates a format constraint for URL validation.

pub fn credit_card( column: impl Into<String>, threshold: f64, detect_only: bool, ) -> Result<Self>

Creates a format constraint for credit card detection.

pub fn phone( column: impl Into<String>, threshold: f64, country: Option<String>, ) -> Result<Self>

Creates a format constraint for phone number validation.

pub fn postal_code( column: impl Into<String>, threshold: f64, country: impl Into<String>, ) -> Result<Self>

Creates a format constraint for postal code validation.

pub fn uuid(column: impl Into<String>, threshold: f64) -> Result<Self>

Creates a format constraint for UUID validation.

pub fn ipv4(column: impl Into<String>, threshold: f64) -> Result<Self>

Creates a format constraint for IPv4 address validation.

pub fn ipv6(column: impl Into<String>, threshold: f64) -> Result<Self>

Creates a format constraint for IPv6 address validation.

pub fn json(column: impl Into<String>, threshold: f64) -> Result<Self>

Creates a format constraint for JSON validation.

pub fn iso8601_datetime( column: impl Into<String>, threshold: f64, ) -> Result<Self>

Creates a format constraint for ISO 8601 date-time validation.

pub fn regex( column: impl Into<String>, pattern: impl Into<String>, threshold: f64, ) -> Result<Self>

Creates a format constraint for custom regex pattern validation.

pub fn social_security_number( column: impl Into<String>, threshold: f64, ) -> Result<Self>

Creates a format constraint for Social Security Number pattern detection.

This method checks for SSN patterns (XXX-XX-XXXX or XXXXXXXXX) and excludes known invalid SSNs such as those starting with 000, 666, or 900-999.

Arguments

• column - The column to check for SSN patterns
• threshold - The minimum ratio of values that must match the SSN pattern (0.0 to 1.0)

Examples

use term_guard::constraints::FormatConstraint;

// Check that at least 95% of values are valid SSN patterns
let ssn_check = FormatConstraint::social_security_number("ssn", 0.95)?;

// For PII detection - flag if more than 1% contain SSN patterns
let ssn_detection = FormatConstraint::social_security_number("description", 0.01)?;

Trait Implementations

impl Clone for FormatConstraint

fn clone(&self) -> FormatConstraint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Constraint for FormatConstraint

fn evaluate<'life0, 'life1, 'async_trait>( &'life0 self, ctx: &'life1 SessionContext, ) -> Pin<Box<dyn Future<Output = Result<ConstraintResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Evaluates the constraint against the data in the session context.

fn name(&self) -> &str

Returns the name of the constraint.

fn column(&self) -> Option<&str>

Returns the column this constraint operates on (if single-column).

fn metadata(&self) -> ConstraintMetadata

Returns the metadata associated with this constraint.

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

Returns a description of what this constraint validates.

impl Debug for FormatConstraint

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

Formats the value using the given formatter.