Struct libkeycard::UserID

pub struct UserID { /* private fields */ }

A basic data type for housing Mensago user IDs. User IDs on the Mensago platform must be no more than 64 ASCII characters. These characters may be from the following: lowercase a-z, numbers, a dash, or an underscore. Periods may also be used so long as they are not consecutive.

Implementations

impl UserID

pub fn from(data: &str) -> Option<UserID>

Creates a UserID from an existing string. If it contains illegal characters, it will return None. All capital letters will have their case squashed for compliance.

pub fn from_wid(wid: &RandomID) -> UserID

Creates a UserID from a workspace ID

pub fn as_string(&self) -> &str

Returns the UserID as a string

pub fn get_type(&self) -> IDType

Returns true if the UserID is also a workspace ID.

Trait Implementations

impl Clone for UserID

fn clone(&self) -> UserID

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserID

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

Formats the value using the given formatter.

impl Display for UserID

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

Formats the value using the given formatter.

impl PartialEq<UserID> for UserID

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

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

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

This method tests for !=.

impl PartialOrd<UserID> for UserID

fn partial_cmp(&self, other: &UserID) -> 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 StructuralPartialEq for UserID