Struct strife::model::user::Discriminator

pub struct Discriminator(_);

A 4-digit user discriminator tag.

Methods

impl Discriminator

pub fn new(value: u16) -> Result<Discriminator, DiscriminatorParseError>

Creates a 4-digit discriminator tag from the given value.

Examples

Basic usage:

use strife::model::user::Discriminator;

let discriminator = Discriminator::new(123)?;

assert_eq!("0123".parse::<Discriminator>()?, discriminator);

Invalid:

use strife::model::user::Discriminator;

// Value is too large to be a valid discriminator.
let discriminator = 12345;

assert!(Discriminator::new(discriminator).is_err());

See the docs for DiscriminatorParseError for more details.

pub unsafe fn new_unchecked(value: u16) -> Discriminator

Constructs a 4-digit discriminator tag from the given value without checking that the value is a 4-digit base-10 integer.

See the safe function, Discriminator::new, for more information.

Safety

This function is unsafe because it does not check that value <= 9999. If this constraint is violated, undefined behavior results, as the rest of the library assumes that discriminator value is a 4-digit base-10 integer.

Trait Implementations

impl AsRef<u16> for Discriminator

fn as_ref(&self) -> &u16

Performs the conversion.

impl Clone for Discriminator

fn clone(&self) -> Discriminator

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Discriminator

impl Debug for Discriminator

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Discriminator

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Discriminator

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

Formats the value using the given formatter.

impl Eq for Discriminator

impl FromStr for Discriminator

type Err = DiscriminatorParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Ord for Discriminator

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Discriminator> for Discriminator

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

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

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

This method tests for !=.

impl PartialOrd<Discriminator> for Discriminator

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

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

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

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

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

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

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

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

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

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

impl Serialize for Discriminator

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for Discriminator

impl StructuralPartialEq for Discriminator