Struct precis_profiles::UsernameCaseMapped

pub struct UsernameCaseMapped(/* private fields */);

UsernameCaseMapped. Profile designed to deal with usernames in security and application protocols. It replaces the SASLprep profile of Stringprep. Look at the IANA Considerations section for more details.

Example

// create UsernameCaseMapped profile
let profile = UsernameCaseMapped::new();

// prepare string
assert_eq!(profile.prepare("Guybrush"), Ok(Cow::from("Guybrush")));

// UsernameCaseMapped does not accept spaces. Unicode code point 0x0020
assert_eq!(profile.prepare("Guybrush Threepwood"),
   Err(Error::BadCodepoint(CodepointInfo { cp: 0x0020, position: 8, property: DerivedPropertyValue::SpecClassDis })));

// enforce string
assert_eq!(profile.enforce("Guybrush"), Ok(Cow::from("guybrush")));

// compare strings
assert_eq!(profile.compare("Guybrush", "guybrush"), Ok(true));

Implementations

impl UsernameCaseMapped

pub fn new() -> Self

Creates a UsernameCaseMapped profile.

Trait Implementations

impl Clone for UsernameCaseMapped

fn clone(&self) -> UsernameCaseMapped

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UsernameCaseMapped

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

Formats the value using the given formatter.

impl Default for UsernameCaseMapped

fn default() -> UsernameCaseMapped

Returns the “default value” for a type.

impl PartialEq for UsernameCaseMapped

fn eq(&self, other: &UsernameCaseMapped) -> 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 PrecisFastInvocation for UsernameCaseMapped

fn prepare<'a, S>(s: S) -> Result<Cow<'a, str>, Error>

where S: Into<Cow<'a, str>>,

Ensures that the code points in a single input string are allowed by the underlying PRECIS string class, and sometimes also entails applying one or more of the rules specified for a particular string class or profile thereof.

fn enforce<'a, S>(s: S) -> Result<Cow<'a, str>, Error>

where S: Into<Cow<'a, str>>,

Applies all rules specified for a particular string class, or profile thereof, to a single input string, for the purpose of checking whether the string conforms to all the rules and thus determining if the string can be used in a given protocol slot.

fn compare<A, B>(s1: A, s2: B) -> Result<bool, Error>

where A: AsRef<str>, B: AsRef<str>,

Comparison entails applying all the rules specified for a particular string class, or profile thereof, to two separate input strings, for the purpose of determining if the two strings are equivalent.

impl Profile for UsernameCaseMapped

fn prepare<'a, S>(&self, s: S) -> Result<Cow<'a, str>, Error>

where S: Into<Cow<'a, str>>,

Ensures that the code points in a single input string are allowed by the underlying PRECIS string class, and sometimes also entails applying one or more of the rules specified for a particular string class or profile thereof.

fn enforce<'a, S>(&self, s: S) -> Result<Cow<'a, str>, Error>

where S: Into<Cow<'a, str>>,

Applies all the rules specified for a particular string class, or profile thereof, to a single input string, for the purpose of checking whether the string conforms to all the rules and thus determining if the string can be used in a given protocol slot.

fn compare<A, B>(&self, s1: A, s2: B) -> Result<bool, Error>

where A: AsRef<str>, B: AsRef<str>,

Comparison entails applying all the rules specified for a particular string class, or profile thereof, to two separate input strings, for the purpose of determining if the two strings are equivalent.

impl Rules for UsernameCaseMapped

fn width_mapping_rule<'a, T>(&self, s: T) -> Result<Cow<'a, str>, Error>

where T: Into<Cow<'a, str>>,

Applies the width mapping rule of a profile to an input string.

fn case_mapping_rule<'a, T>(&self, s: T) -> Result<Cow<'a, str>, Error>

where T: Into<Cow<'a, str>>,

Applies the case mapping rule of a profile to an input string

fn normalization_rule<'a, T>(&self, s: T) -> Result<Cow<'a, str>, Error>

where T: Into<Cow<'a, str>>,

Applies the normalization rule of a profile to an input string

fn directionality_rule<'a, T>(&self, s: T) -> Result<Cow<'a, str>, Error>

where T: Into<Cow<'a, str>>,

Applies the directionality rule of a profile to an input string

fn additional_mapping_rule<'a, T>(&self, _s: T) -> Result<Cow<'a, str>, Error>

where T: Into<Cow<'a, str>>,

Applies the additional mapping rule of a profile to an input string.

impl Copy for UsernameCaseMapped

impl Eq for UsernameCaseMapped

impl StructuralPartialEq for UsernameCaseMapped