precis-profiles 0.1.11

Implementation of the PRECIS Framework: Preparation, Enforcement, and Comparison of Internationalized Strings Representing Usernames and Passwords as defined in rfc8265; and Nicknames as defined in rfc8266.
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

//! PRECIS Framework: Preparation, Enforcement, and Comparison of
//! Internationalized Strings in Application Protocols as described in
//! [`rfc8264`](https://datatracker.ietf.org/doc/html/rfc8264)
//!
//! This crate implements the next PRECIS profiles:
//! * [`rfc8265`](https://datatracker.ietf.org/doc/html/rfc8265).
//!   Preparation, Enforcement, and Comparison of Internationalized Strings
//!   Representing `Usernames` and `Passwords`.
//! * [`rfc8266`](https://datatracker.ietf.org/doc/html/rfc8266).
//!   Preparation, Enforcement, and Comparison of Internationalized Strings
//!   Representing Nicknames
//!
//! ```rust
//! # use precis_core::profile::PrecisFastInvocation;
//! # use precis_profiles::Nickname;
//! # use std::borrow::Cow;
//! assert_eq!(Nickname::prepare("Guybrush Threepwood"),
//!   Ok(Cow::from("Guybrush Threepwood")));
//! assert_eq!(Nickname::enforce("   Guybrush     Threepwood  "),
//!   Ok(Cow::from("Guybrush Threepwood")));
//! assert_eq!(Nickname::compare("Guybrush   Threepwood  ",
//!   "guybrush threepwood"), Ok(true));
//! ```

#![deny(missing_docs)]

include!(concat!(env!("OUT_DIR"), "/unicode_version.rs"));

mod bidi;
mod common;
mod nicknames;
mod passwords;
mod usernames;

pub use crate::nicknames::Nickname;
pub use crate::passwords::OpaqueString;
pub use crate::usernames::UsernameCaseMapped;
pub use crate::usernames::UsernameCasePreserved;
pub use precis_core;