Struct precis_profiles::OpaqueString

pub struct OpaqueString(_);

OpaqueString Profile designed to deal with passwords and other opaque strings in security and application protocols. Replaces: The SASLprep profile of Stringprep. Look at the IANA Considerations section for more details.

Example

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

// prepare string
assert_eq!(profile.prepare("I'm Guybrush Threepwood, Mighty Pirate ☠"),
    Ok(Cow::from("I'm Guybrush Threepwood, Mighty Pirate ☠")));

// enforce string
assert_eq!(profile.enforce("Look behind you, a three-headed monkey!🐒"),
    Ok(Cow::from("Look behind you, a three-headed monkey!🐒")));

// compare strings
assert_eq!(profile.compare("That’s the second biggest 🐵 I’ve ever seen!",
    "That’s the second biggest 🐵 I’ve ever seen!"), Ok(true));

Implementations

impl OpaqueString

pub fn new() -> Self

Creates a OpaqueString profile.

Trait Implementations

impl Clone for OpaqueString

fn clone(&self) -> OpaqueString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OpaqueString

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

Formats the value using the given formatter.

impl Default for OpaqueString

fn default() -> OpaqueString

Returns the “default value” for a type.

impl PartialEq<OpaqueString> for OpaqueString

fn eq(&self, other: &OpaqueString) -> bool

This method tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PrecisFastInvocation for OpaqueString

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 OpaqueString

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 OpaqueString

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.

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

impl Copy for OpaqueString

impl Eq for OpaqueString

impl StructuralEq for OpaqueString

impl StructuralPartialEq for OpaqueString