Struct precis_profiles::UsernameCasePreserved

pub struct UsernameCasePreserved { /* fields omitted */ }

UsernameCasePreserved Profile. 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

use precis_core::Error;
use precis_core::profile::Profile;
use precis_profiles::UsernameCasePreserved;
use std::borrow::Cow;

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

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

// UsernameCaseMapped does not accept spaces
assert_eq!(profile.prepare("Guybrush Threepwood"),
   Err(Error::Disallowed));

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

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

Implementations

impl UsernameCasePreserved

pub fn new() -> Self

Trait Implementations

impl Default for UsernameCasePreserved

fn default() -> Self

Returns the “default value” for a type.

impl PrecisFastInvocation for UsernameCasePreserved

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

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

fn compare(s1: &str, s2: &str) -> Result<bool, Error>

impl Profile for UsernameCasePreserved

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

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>(&self, s: &'a str) -> Result<Cow<'a, str>, Error>

Applies all of 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 of the rules and thus determining if the string can be used in a given protocol slot.

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

Comparison entails applying all of 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 UsernameCasePreserved

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 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>>, 

Appies the additional 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