Struct phonenumber::metadata::Descriptor

pub struct Descriptor { /* private fields */ }

Description of a phone number to parse.

Implementations

impl Descriptor

pub fn national_number(&self) -> &CachedRegex

The national number is the pattern that a valid national significant number would match. This specifies information such as its total length and leading digits.

pub fn possible_length(&self) -> &[u16]

These represent the lengths a phone number from this region can be. They will be sorted from smallest to biggest. Note that these lengths are for the full number, without country calling code or national prefix. For example, for the Swiss number +41789270000, in local format 0789270000, this would be 9.

This could be used to highlight tokens in a text that may be a phone number, or to quickly prune numbers that could not possibly be a phone number for this locale.

pub fn possible_local_length(&self) -> &[u16]

These represent the lengths that only local phone numbers (without an area code) from this region can be. They will be sorted from smallest to biggest. For example, since the American number 456-1234 may be locally diallable, although not diallable from outside the area, 7 could be a possible value. This could be used to highlight tokens in a text that may be a phone number.

To our knowledge, area codes are usually only relevant for some fixed-line and mobile numbers, so this field should only be set for those types of numbers (and the general description) - however there are exceptions for NANPA countries.

This data is used to calculate whether a number could be a possible number for a particular type.

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

An example national significant number for the specific type. It should not contain any formatting information.

pub fn is_match(&self, value: &str) -> bool

Check if the descriptor matches the given national number.

Trait Implementations

impl Clone for Descriptor

fn clone(&self) -> Descriptor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Descriptor

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

Formats the value using the given formatter.