Struct CCashUser 

pub struct CCashUser { /* private fields */ }

User struct that can be used for authentication purposes.

Implementations

impl CCashUser

pub fn new(username: &str, password: &str) -> Result<Self, CCashUsernameError>

Creates a new user where the username is checked against CCash’s requirements. This is the recommended way to create a CCashUser as it is guaranteed to not cause CCash to reject the username. username will automatically be made lowercase.

Errors

• Returns CCashUsernameError::NameTooShort if given username is shorter than 3 characters.
• Returns CCashUsernameError::NameTooLong if given username is longer than 16 characters.
• Returns CCashUsernameError::NameContainsInvalidCharacters if given username otherwise contains invalid characters such as spaces.

pub fn new_unchecked(username: &str, password: &str) -> Self

Creates a new CCashUser with an unchecked username against CCash’s requirements. This method is not recommended as it could cause hard-to-diagnose or confusing errors from CCash for the user.

pub fn get_username(&self) -> &str

Returns an immutable reference to the CCashUser’s username.

pub fn get_password(&self) -> &str

Returns an immutable reference to the CCashUser’s password.

Trait Implementations

impl Clone for CCashUser

fn clone(&self) -> CCashUser

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CCashUser

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CCashUser

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for CCashUser

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 PartialEq for CCashUser

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CCashUser

impl StructuralPartialEq for CCashUser