Struct DisplayMask 

pub struct DisplayMask { /* private fields */ }

Implementations

impl DisplayMask

pub fn new(pattern: impl Into<String>, input_char: char) -> Self

Create a new display mask with dynamic mode (current behavior)

Arguments

• pattern - The mask pattern (e.g., “##-##-####”, “(###) ###-####”)
• input_char - Character representing input positions (usually ‘#’)

Examples

use validation_core::DisplayMask;

// Phone number format
let phone_mask = DisplayMask::new("(###) ###-####", '#');

// Date format  
let date_mask = DisplayMask::new("##/##/####", '#');

// Custom business format
let employee_id = DisplayMask::new("EMP-####-##", '#');

pub fn with_mode(self, mode: MaskDisplayMode) -> Self

Set the display mode for this mask

Examples

use validation_core::{DisplayMask, MaskDisplayMode};

let dynamic_mask = DisplayMask::new("##-##", '#')
    .with_mode(MaskDisplayMode::Dynamic);
     
let template_mask = DisplayMask::new("##-##", '#')
    .with_mode(MaskDisplayMode::Template { placeholder: '_' });

pub fn with_template(self, placeholder: char) -> Self

Set template mode with custom placeholder

Examples

use validation_core::DisplayMask;

let phone_template = DisplayMask::new("(###) ###-####", '#')
    .with_template('_');  // Shows "(___) ___-____" when empty
     
let date_dots = DisplayMask::new("##/##/####", '#')
    .with_template('•');  // Shows "••/••/••••" when empty

pub fn apply_to_display(&self, raw_input: &str) -> String

Apply mask to raw input, showing visual separators and handling display mode

pub fn is_input_position(&self, display_position: usize) -> bool

Check if a display position should accept cursor/input

pub fn display_pos_to_raw_pos(&self, display_pos: usize) -> usize

Map display position to raw position

pub fn raw_pos_to_display_pos(&self, raw_pos: usize) -> usize

Map raw position to display position

pub fn next_input_position(&self, display_pos: usize) -> usize

Find next input position at or after the given display position

pub fn prev_input_position(&self, display_pos: usize) -> Option<usize>

Find previous input position at or before the given display position

pub fn display_mode(&self) -> &MaskDisplayMode

Get the display mode

pub fn is_template_mode(&self) -> bool

Check if this mask uses template mode

pub fn pattern(&self) -> &str

Get the pattern string

pub fn input_char(&self) -> char

Get the input placeholder character

pub fn first_input_position(&self) -> usize

Get the position of the first input character in the pattern

Trait Implementations

impl Clone for DisplayMask

fn clone(&self) -> DisplayMask

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DisplayMask

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

Formats the value using the given formatter.

impl Default for DisplayMask

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DisplayMask

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for DisplayMask

impl PartialEq for DisplayMask

fn eq(&self, other: &DisplayMask) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DisplayMask

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DisplayMask