rlibphonenumber 2.2.4

A high-performance Rust port of Google's libphonenumber for parsing, formatting, and validating international phone numbers.
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

//! Phone number matching and extraction utilities.
//!
//! This module provides tools to scan plain text and extract valid phone numbers.
//! It handles different leniency levels, regional formatting, and text normalization.
//!
//! # Fallibility and Custom Metadata
//!
//! When configuring a matcher, you can choose between an **infallible** matcher
//! ([`PhoneNumberMatcher`]) and a **fallible** matcher ([`PhoneNumberMatcherFallible`]).
//!
//! It is crucial to understand that the errors returned by the fallible matcher are
//! **strictly internal errors** caused by broken or malformed metadata (e.g., invalid
//! regular expressions or logical flaws in the metadata tree). They are *not* parsing
//! errors for the user's text (invalid phone numbers in the text are simply skipped
//! by both matchers).
//!
//! - **Infallible (`PhoneNumberMatcher`)**: This is the default and recommended matcher.
//!   If it encounters corrupted metadata, it will **panic**. This behavior is perfectly
//!   safe and expected when using the default, built-in metadata.
//! - **Fallible (`PhoneNumberMatcherFallible`)**: Yields `Result` items, allowing you to
//!   catch internal metadata errors. You should only use this if you are dynamically
//!   loading arbitrary, untested custom metadata at runtime and need to prevent panics.
//!
//! **Best Practice Recommendation**:
//! Instead of handling metadata errors at runtime via the fallible matcher, it is highly
//! recommended to pre-test and validate any custom metadata using the `rlibphonenumber` CLI
//! tool before compiling or deploying. Once validated, you can safely use the infallible
//! matcher for better ergonomics and performance.

mod leniency;
mod matcher_internal;
mod matcher_regex;
mod phonenumber_match;
mod phonenumber_match_factory;

pub use {
    leniency::Leniency,
    matcher_internal::{PhoneNumberMatcher, PhoneNumberMatcherFallible},
    phonenumber_match::PhoneNumberMatch,
    phonenumber_match_factory::{MatcherBuilder, PhoneNumberMatcherFactory},
};

#[cfg(feature = "global_static")]
pub use phonenumber_match_factory::{FindNumberExt, PHONE_MATCHER_FACTORY};

#[cfg(test)]
pub use matcher_internal::PhoneNumberMatcherInternal;