Struct wow_srp::normalized_string::NormalizedString

pub struct NormalizedString { /* private fields */ }

Represents usernames and passwords containing only allowed characters.

See module normalized_string for more information.

The NormalizedString::new method will always take the format that requires the least amount of translation to the underlying string format. This method can change interface completely without it being a breaking change. This is done deliberately in order to alert users of changes that could impact performance.

Iif you want stability Use the NormalizedString::from_string or NormalizedString::from_str.

use wow_srp::error::NormalizedStringError;
use wow_srp::normalized_string::NormalizedString;

// From &str
let username = "Alice";
let username: NormalizedString = username.try_into()?;

// From string
let password = String::from("hunter2");
let password: NormalizedString = password.try_into()?;

Implementations

impl NormalizedString

pub fn new(s: impl AsRef<str>) -> Result<Self, NormalizedStringError>

Checks for non-ASCII characters and too large of a string and correctly uppercases letters as needed.

Allowed characters are all ASCII characters except for ASCII control characters.

Errors

See the module level docs for explanation of allowed values.

pub fn from_str(s: impl AsRef<str>) -> Result<Self, NormalizedStringError>

Checks for non-ASCII characters and too large of a string and correctly uppercases letters as needed.

Allowed characters are all ASCII characters except for ASCII control characters.

Errors

See the module level docs for explanation of allowed values.

pub fn from_string(s: impl Into<String>) -> Result<Self, NormalizedStringError>

Checks for non-ASCII characters and too large of a string and correctly uppercases letters as needed.

Allowed characters are all ASCII characters except for ASCII control characters.

Errors

See the module level docs for explanation of allowed values.

Trait Implementations

impl AsRef<str> for NormalizedString

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for NormalizedString

fn clone(&self) -> NormalizedString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NormalizedString

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

Formats the value using the given formatter.

impl Display for NormalizedString

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

Formats the value using the given formatter.

impl Hash for NormalizedString

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for NormalizedString

fn cmp(&self, other: &NormalizedString) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for NormalizedString

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

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

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 PartialOrd for NormalizedString

fn partial_cmp(&self, other: &NormalizedString) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<&str> for NormalizedString

type Error = NormalizedStringError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for NormalizedString

type Error = NormalizedStringError

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for NormalizedString

impl StructuralPartialEq for NormalizedString