Struct precis_profiles::Nickname

pub struct Nickname { /* fields omitted */ }

Nickname. Nicknames or display names in messaging and text conferencing technologies; pet names for devices, accounts, and people; and other uses of nicknames, display names, or pet names. Look at the IANA Considerations section for more details.

Example

use precis_core::profile::Profile;
use precis_profiles::Nickname;
use std::borrow::Cow;

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

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

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

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

Implementations

impl Nickname

pub fn new() -> Self

Creates a Nickname profile.

Trait Implementations

impl Default for Nickname

fn default() -> Self

Returns the “default value” for a type.

impl PrecisFastInvocation for Nickname

fn prepare(s: &str) -> Result<Cow<'_, 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(s: &str) -> Result<Cow<'_, str>, Error>

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(s1: &str, s2: &str) -> Result<bool, Error>

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 Nickname

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 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(&self, s1: &str, s2: &str) -> Result<bool, Error>

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 Nickname

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