Struct UserId

pub struct UserId(/* private fields */);

An identifier for a User

Implementations

impl UserId

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

Creates a new UserId from a u64.

Panics

Panics if id is zero.

pub const fn get(self) -> u64

Retrieves the inner id as a u64.

pub fn created_at(&self) -> Timestamp

Retrieves the time that the UserId was created.

impl UserId

pub async fn create_dm_channel( self, cache_http: impl CacheHttp, ) -> Result<PrivateChannel>

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.

pub async fn direct_message( self, cache_http: impl CacheHttp, builder: CreateMessage, ) -> Result<Message>

Sends a message to a user through a direct message channel. This is a channel that can only be accessed by you and the recipient.

Examples

When a user sends a message with a content of "~help", DM the author a help message

use serenity::builder::CreateMessage;

#[serenity::async_trait]
impl EventHandler for Handler {
    async fn message(&self, ctx: Context, msg: Message) {
        if msg.content == "~help" {
            let builder = CreateMessage::new().content("Helpful info here.");

            if let Err(why) = msg.author.id.direct_message(&ctx, builder).await {
                println!("Err sending help: {why:?}");
                let _ = msg.reply(&ctx, "There was an error DMing you help.").await;
            };
        }
    }
}

Errors

Returns a ModelError::MessagingBot if the user being direct messaged is a bot user.

May also return an Error::Http if the user cannot be sent a direct message.

Returns an Error::Json if there is an error deserializing the API response.

pub async fn dm( self, cache_http: impl CacheHttp, builder: CreateMessage, ) -> Result<Message>

This is an alias of Self::direct_message.

pub fn to_user_cached(self, cache: &impl AsRef<Cache>) -> Option<UserRef<'_>>

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

pub async 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.

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

impl AsRef<UserId> for UserId

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

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

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

Formats the value using the given formatter.

impl Default for UserId

fn default() -> Self

Returns the “default value” for a type.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for UserId

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

Formats the value using the given formatter.

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<'a> From<&'a UserId> for UserId

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

Converts to this type from the input type.

impl From<CommandPermissionId> for UserId

fn from(id: CommandPermissionId) -> Self

Converts to this type from the input type.

impl From<Member> for UserId

fn from(member: Member) -> UserId

Gets the Id of a Member.

impl From<NonZero<u64>> for UserId

fn from(id: NonZeroU64) -> UserId

Converts to this type from the input type.

impl From<TargetId> for UserId

fn from(id: TargetId) -> Self

Converts to this type from the input type.

impl From<User> for UserId

fn from(user: User) -> UserId

Gets the Id of a User.

impl From<UserId> for CommandPermissionId

fn from(id: UserId) -> Self

Converts to this type from the input type.

impl From<UserId> for Mention

fn from(value: UserId) -> Self

Converts to this type from the input type.

impl From<UserId> for NonZeroI64

fn from(id: UserId) -> NonZeroI64

Converts to this type from the input type.

impl From<UserId> for NonZeroU64

fn from(id: UserId) -> NonZeroU64

Converts to this type from the input type.

impl From<UserId> for TargetId

fn from(id: UserId) -> Self

Converts to this type from the input type.

impl From<UserId> for i64

fn from(id: UserId) -> i64

Converts to this type from the input type.

impl From<UserId> for u64

fn from(id: UserId) -> u64

Converts to this type from the input type.

impl From<u64> for UserId

fn from(id: u64) -> UserId

Converts to this type from the input type.

impl FromStr for UserId

type Err = <u64 as FromStr>::Err

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 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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for UserId

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

fn eq(&self, u: &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 PartialEq for UserId

fn eq(&self, other: &UserId) -> 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 PartialOrd 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: &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 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 Copy for UserId

impl Eq for UserId

impl StructuralPartialEq for UserId