Struct Id

pub struct Id<T> { /* private fields */ }

ID of a resource, such as the ID of a channel or user.

Markers themselves perform no logical action, and are only used to ensure that IDs of incorrect types aren’t used. Read the marker documentation for additional information.

serde

This ID deserializes from both integers and strings and serializes into a string.

Implementations

impl<T> Id<T>

pub const fn new(n: u64) -> Self

Create a new ID, panicking if the value is zero.

This is primarily useful in const contexts where you are passing a hardcoded value.

Refer to new_checked for a checked alternative to this method.

Examples

use twilight_model::id::{marker::GenericMarker, Id};

const ID: Id<GenericMarker> = Id::new(123);

println!("id: {ID}");

Panics

Panics if the value is 0.

pub const unsafe fn new_unchecked(n: u64) -> Self

Create an ID without checking if the value is non-zero.

Equivalent to NonZeroU64::new_unchecked.

Safety

The value must not be zero.

pub const fn new_checked(n: u64) -> Option<Self>

Create an ID if the provided value is not zero.

Examples

use twilight_model::id::{marker::GenericMarker, Id};

assert!(Id::<GenericMarker>::new_checked(123).is_some());
assert!(Id::<GenericMarker>::new_checked(0).is_none());

Equivalent to NonZeroU64::new.

pub const fn get(self) -> u64

Return the inner primitive value.

Equivalent to NonZeroU64::get.

Examples

Create an ID with a value and then confirm its inner value:

use twilight_model::id::{marker::ChannelMarker, Id};

let channel_id = Id::<ChannelMarker>::new(7);

assert_eq!(7, channel_id.get());

pub const fn into_nonzero(self) -> NonZeroU64

Return the NonZeroU64 representation of the ID.

Examples

Create an ID with a value and then confirm its nonzero value:

use std::num::NonZeroU64;
use twilight_model::id::{marker::ChannelMarker, Id};

let channel_id = Id::<ChannelMarker>::new(7);

assert_eq!(NonZeroU64::new(7).unwrap(), channel_id.into_nonzero());

pub const fn cast<New>(self) -> Id<New>

Cast an ID from one type to another.

Examples

Cast a role ID to a guild ID, useful for the @everyone role:

use twilight_model::id::{
    marker::{GuildMarker, RoleMarker},
    Id,
};

let role_id: Id<RoleMarker> = Id::new(1);

let guild_id: Id<GuildMarker> = role_id.cast();
assert_eq!(1, guild_id.get());

Trait Implementations

impl<T> Clone for Id<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Id<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Id<T>

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

Deserialize this value from the given Serde deserializer.

impl<T> Display for Id<T>

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

Formats the value using the given formatter.

impl<T> From<Id<T>> for NonZeroU64

fn from(id: Id<T>) -> Self

Converts to this type from the input type.

impl<T> From<Id<T>> for u64

fn from(id: Id<T>) -> Self

Converts to this type from the input type.

impl<T> From<NonZero<u64>> for Id<T>

fn from(id: NonZeroU64) -> Self

Converts to this type from the input type.

impl<T> FromStr for Id<T>

type Err = ParseIntError

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<T> Hash for Id<T>

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

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<T> Ord for Id<T>

fn cmp(&self, other: &Self) -> 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,

Restrict a value to a certain interval.

impl<T> PartialEq<Id<T>> for i64

fn eq(&self, other: &Id<T>) -> 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<T> PartialEq<Id<T>> for u64

fn eq(&self, other: &Id<T>) -> 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<T> PartialEq<i64> for Id<T>

fn eq(&self, other: &i64) -> 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<T> PartialEq<u64> for Id<T>

fn eq(&self, other: &u64) -> 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<T> PartialEq for Id<T>

fn eq(&self, other: &Self) -> 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<T> PartialOrd for Id<T>

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<T> Serialize for Id<T>

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

Serialize this value into the given Serde serializer.

impl<T> TryFrom<i64> for Id<T>

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> TryFrom<u64> for Id<T>

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> Copy for Id<T>

impl<T> Eq for Id<T>