Struct serenity::model::id::UserId

pub struct UserId(pub u64);

An identifier for a User

Implementations

impl UserId

pub fn created_at(&self) -> DateTime<FixedOffset>

Retrieves the time that the Id was created at.

pub fn as_u64(&self) -> &u64

Immutably borrow inner Id.

pub fn as_mut_u64(&mut self) -> &mut u64

Mutably borrow inner Id.

impl UserId

pub fn create_dm_channel(self, http: impl AsRef<Http>) -> Result<PrivateChannel>

Creates a direct message channel between the current user and the user. This can also retrieve the channel if one already exists.

pub fn to_user_cached(
    self,
    cache: impl AsRef<CacheRwLock>
) -> Option<Arc<RwLock<User>>>

Attempts to find a User by its Id in the cache.

pub fn to_user(self, cache_http: impl CacheHttp) -> Result<User>

First attempts to find a User by its Id in the cache, upon failure requests it via the REST API.

Note: If the cache is not enabled, REST API will be used only.

Trait Implementations

impl AsRef<UserId> for UserId

fn as_ref(&self) -> &Self

Performs the conversion.

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 Copy for UserId

impl Debug for UserId

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

Formats the value using the given formatter.

impl Default for UserId

fn default() -> UserId

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for UserId

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

Deserialize this value from the given Serde deserializer.

impl Display for UserId

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

Formats the value using the given formatter.

impl Eq for UserId

impl<'a> From<&'a CurrentUser> for UserId

fn from(current_user: &CurrentUser) -> UserId

Gets the Id of a CurrentUser struct.

impl<'a> From<&'a Member> for UserId

fn from(member: &Member) -> UserId

Gets the Id of a Member.

impl<'a> From<&'a User> for UserId

fn from(user: &User) -> UserId

Gets the Id of a User.

impl<'a> From<&'a UserId> for UserId

fn from(id: &'a UserId) -> UserId

Performs the conversion.

impl From<CurrentUser> for UserId

fn from(current_user: CurrentUser) -> UserId

Gets the Id of a CurrentUser struct.

impl From<Member> for UserId

fn from(member: Member) -> UserId

Gets the Id of a Member.

impl From<User> for UserId

fn from(user: User) -> UserId

Gets the Id of a User.

impl From<UserId> for u64

fn from(id: UserId) -> u64

Performs the conversion.

impl From<UserId> for i64

fn from(id: UserId) -> i64

Performs the conversion.

impl From<u64> for UserId

fn from(id_as_u64: u64) -> UserId

Performs the conversion.

impl FromStr for UserId

type Err = UserIdParseError

The associated error which can be returned from parsing.

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

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

impl Hash for UserId

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 Mentionable for UserId

fn mention(&self) -> String

Creates a mentionable string, that will be able to notify and/or create a link to the item.

impl Ord for UserId

fn cmp(&self, other: &UserId) -> 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<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 PartialEq<u64> for UserId

fn eq(&self, u: &u64) -> 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<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: &UserId) -> bool

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

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

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

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

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

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

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

impl Serialize for UserId

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 UserId

impl StructuralPartialEq for UserId