tui-canvas 0.8.10

Form/textarea/input for TUI
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

// src/validation/mod.rs
//! Validation subsystem re-exports and helpers.
//!
//! This module collects validation-related modules (limits, masks, patterns,
//! formatting, and state) and re-exports the most commonly used types so that
//! callers can import them from `crate::validation`.
//!
//! Server-integration note:
//! - Canvas validation types are intentionally structured, not string-based.
//! - This makes them a good target for server-stored validation definitions that
//!   clients fetch and translate into local runtime config.
//! - In the shared server model:
//!   - `CharacterLimits` maps to server `limits`
//!   - position-based filters map to server `pattern`
//!   - `DisplayMask` is presentation metadata only, not stored value format
//!   - formatter selection should be represented as data and resolved through a
//!     client-side formatter registry
//! - Raw stored values should remain unmasked even when a display mask is used.

pub mod config;
pub mod formatting;
pub mod limits;
pub mod mask;
pub mod patterns;
pub mod state;

pub use config::{ValidationConfig, ValidationConfigBuilder, ValidationResult};
pub use formatting::{CustomFormatter, DefaultPositionMapper, FormattingResult, PositionMapper};
pub use limits::{CharacterLimits, LimitCheckResult};
pub use mask::DisplayMask;
pub use patterns::{CharacterFilter, PatternFilters, PositionFilter, PositionRange};
pub use state::{ValidationState, ValidationSummary};
pub use validation_core::{AppliedValidation, ValidationRule, ValidationSet, ValidationSettings};

/// External validation UI state.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ExternalValidationState {
    NotValidated,
    Validating,
    Valid(Option<String>),
    Invalid {
        message: String,
        suggestion: Option<String>,
    },
    Warning {
        message: String,
    },
}

/// Validation error types.
#[derive(Debug, Clone, thiserror::Error)]
pub enum ValidationError {
    #[error("Character limit exceeded: {message}")]
    LimitExceeded { message: String },

    #[error("Pattern validation failed: {message}")]
    PatternFailed { message: String },

    #[error("Custom validation failed: {message}")]
    CustomFailed { message: String },
}