Enum MaskPattern 

pub enum MaskPattern {
    None,
    Pattern {
        pattern: SharedString,
        tokens: Vec<MaskToken>,
    },
    Number {
        separator: Option<char>,
        fraction: Option<usize>,
    },
}

Variants

None

Pattern

Fields

pattern: SharedString

tokens: Vec<MaskToken>

Number

Fields

separator: Option<char>

Group separator, e.g. “,” or “ “

fraction: Option<usize>

Number of fraction digits, e.g. 2 for 123.45

Implementations

impl MaskPattern

pub fn new(pattern: &str) -> Self

Create a new mask pattern

• 9 - Digit
• A - Letter
• # - Letter or Digit
• * - Any character
• other characters - Separator

For example:

• (999)999-9999 - US phone number: (123)456-7890
• 99999-9999 - ZIP code: 12345-6789
• AAAA-99-#### - Custom pattern: ABCD-12-3AB4
• *999* - Custom pattern: (123) or [123]

pub fn number(sep: Option<char>) -> Self

Create a new mask pattern with group separator, e.g. “,” or “ “

pub fn placeholder(&self) -> Option<String>

pub fn is_none(&self) -> bool

Return true if the mask pattern is None or no any pattern.

pub fn is_valid(&self, mask_text: &str) -> bool

Check is the mask text is valid.

If the mask pattern is None, always return true.

pub fn is_valid_at(&self, ch: char, pos: usize) -> bool

Check if valid input char at the given position.

pub fn mask(&self, text: &str) -> SharedString

Format the text according to the mask pattern

For example:

• pattern: (999)999-999
• text: 123456789
• mask_text: (123)456-789

pub fn unmask(&self, mask_text: &str) -> String

Extract original text from masked text

Trait Implementations

impl Clone for MaskPattern

fn clone(&self) -> MaskPattern

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for MaskPattern

fn default() -> MaskPattern

Returns the “default value” for a type.

impl From<&str> for MaskPattern

fn from(pattern: &str) -> Self

Converts to this type from the input type.