Struct ichen_openprotocol::ID

pub struct ID(_);

A 32-bit numeric ID that cannot be zero or negative.

This type is usually used for specifying a unique identification number.

Methods

impl ID

pub fn new(value: u32) -> Option<Self>

Create a new ID from a u32 value.

Errors

Returns None if value is zero.

Examples

let id = ID::new(42).unwrap();
assert_eq!(42, u32::from(id));
assert_eq!(None, ID::new(0));

pub fn from_u32(value: u32) -> Self

Create a new ID from a u32 value.

Panics

Panics if value is zero.

Error Examples

let id = ID::from_u32(0);    // This will panic.

Examples

let id = ID::from_u32(42);
assert_eq!(42, id.get());

pub fn get(self) -> u32

Convert an ID into a u32 value.

Examples

let id = ID::new(42).unwrap();
assert_eq!(42, id.get());

Methods from Deref<Target = NonZeroU32>

Trait Implementations

impl AsMut<NonZeroU32> for ID

fn as_mut(&mut self) -> &mut NonZeroU32

Performs the conversion.

impl AsRef<NonZeroU32> for ID

fn as_ref(&self) -> &NonZeroU32

Performs the conversion.

impl Clone for ID

fn clone(&self) -> ID

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ID

impl Debug for ID

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

Formats the value using the given formatter.

impl Deref for ID

type Target = NonZeroU32

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for ID

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for ID

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

Deserialize this value from the given Serde deserializer.

impl Display for ID

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

Formats the value using the given formatter.

impl Eq for ID

impl From<ID> for NonZeroU32

fn from(original: ID) -> NonZeroU32

Performs the conversion.

impl From<ID> for u32

fn from(id: ID) -> Self

Performs the conversion.

impl From<NonZeroU32> for ID

fn from(original: NonZeroU32) -> ID

Performs the conversion.

impl FromStr for ID

type Err = <NonZeroU32 as FromStr>::Err

The associated error which can be returned from parsing.

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

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

impl Hash for ID

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, 

Feeds a slice of this type into the given [Hasher].

impl Ord for ID

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

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] 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<ID> for ID

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

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

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

This method tests for !=.

impl PartialEq<ID> for u32

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<u32> for ID

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<ID> for ID

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

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

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

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

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

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

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

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

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

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

impl PartialOrd<ID> for u32

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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 PartialOrd<u32> for ID

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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 Serialize for ID

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 ID

impl StructuralPartialEq for ID

impl TryFrom<u32> for ID

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<Self, Self::Error>

Create a new ID from an integer value;

Errors

Return Err(&'static str) if num is zero.

Examples

let id = ID::try_from(42).unwrap();
assert_eq!(42, u32::from(id));
assert_eq!(Err("ID value cannot be zero."), ID::try_from(0));