pub struct UserId(pub u64);
Expand description
An identifier for a User
Tuple Fields
0: u64
Implementations
sourceimpl UserId
impl UserId
sourcepub fn created_at(&self) -> Timestamp
pub fn created_at(&self) -> Timestamp
Retrieves the time that the Id was created at.
sourcepub fn as_mut_u64(&mut self) -> &mut u64
pub fn as_mut_u64(&mut self) -> &mut u64
Mutably borrow inner Id.
sourceimpl UserId
impl UserId
sourcepub async fn create_dm_channel(
self,
cache_http: impl CacheHttp
) -> Result<PrivateChannel>
Available on crate feature model
only.
pub async fn create_dm_channel(
self,
cache_http: impl CacheHttp
) -> Result<PrivateChannel>
model
only.Creates a direct message channel between the current user and the user. This can also retrieve the channel if one already exists.
Errors
Returns Error::Http
if a User
with that UserId
does not exist,
or is otherwise unavailable.
May also return an Error::Json
if there is an error in deserializing
the channel data returned by the Discord API.
sourcepub async fn to_user_cached(self, cache: impl AsRef<Cache>) -> Option<User>
Available on crate features model
and cache
only.
pub async fn to_user_cached(self, cache: impl AsRef<Cache>) -> Option<User>
model
and cache
only.Attempts to find a User
by its Id in the cache.
sourcepub async fn to_user(self, cache_http: impl CacheHttp) -> Result<User>
Available on crate feature model
only.
pub async fn to_user(self, cache_http: impl CacheHttp) -> Result<User>
model
only.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.
Note: If the cache is enabled, you might want to enable the temp_cache
feature to
cache user data retrieved by this function for a short duration.
Errors
May return an Error::Http
if a User
with that UserId
does not exist,
or otherwise cannot be fetched.
May also return an Error::Json
if there is an error in
deserializing the user.
Trait Implementations
sourceimpl<'de> Deserialize<'de> for UserId
impl<'de> Deserialize<'de> for UserId
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl<'a> From<&'a CurrentUser> for UserId
impl<'a> From<&'a CurrentUser> for UserId
sourcefn from(current_user: &CurrentUser) -> UserId
fn from(current_user: &CurrentUser) -> UserId
Gets the Id of a CurrentUser
struct.
sourceimpl<'a> From<&'a UserId> for CommandPermissionId
impl<'a> From<&'a UserId> for CommandPermissionId
sourceimpl From<CommandPermissionId> for UserId
impl From<CommandPermissionId> for UserId
sourcefn from(id: CommandPermissionId) -> Self
fn from(id: CommandPermissionId) -> Self
Converts to this type from the input type.
sourceimpl From<CurrentUser> for UserId
impl From<CurrentUser> for UserId
sourcefn from(current_user: CurrentUser) -> UserId
fn from(current_user: CurrentUser) -> UserId
Gets the Id of a CurrentUser
struct.
sourceimpl From<UserId> for CommandPermissionId
impl From<UserId> for CommandPermissionId
sourceimpl Ord for UserId
impl Ord for UserId
1.21.0 · sourcefn max(self, other: Self) -> Self
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
1.21.0 · sourcefn min(self, other: Self) -> Self
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Self where
Self: PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Self where
Self: PartialOrd<Self>,
Restrict a value to a certain interval. Read more
sourceimpl PartialOrd<UserId> for UserId
impl PartialOrd<UserId> for UserId
sourcefn partial_cmp(&self, other: &UserId) -> Option<Ordering>
fn partial_cmp(&self, other: &UserId) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl Copy for UserId
impl Eq for UserId
impl StructuralEq for UserId
impl StructuralPartialEq for UserId
Auto Trait Implementations
impl RefUnwindSafe for UserId
impl Send for UserId
impl Sync for UserId
impl Unpin for UserId
impl UnwindSafe for UserId
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to key
and return true
if they are equal.
sourceimpl<F> FromStrAndCache for F where
F: FromStr,
impl<F> FromStrAndCache for F where
F: FromStr,
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> Mentionable for T where
T: Into<Mention> + Copy,
impl<T> Mentionable for T where
T: Into<Mention> + Copy,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more