Struct serenity::model::UserId

pub struct UserId(pub u64);

An identifier for a User

Methods

impl UserId

fn create_dm_channel(&self) -> Result<PrivateChannel>

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

fn delete_note(&self) -> Result<()>

Deletes a profile note from a user.

fn edit_note(&self, note: &str) -> Result<()>

Edits the note that the current user has set for another user.

Use delete_note to remove a note.

Refer to the documentation for User::edit_note for more information.

Note: Requires that the current user be a user account.

fn find(&self) -> Option<User>

Search the cache for the user with the Id.

fn get(&self) -> Result<User>

Gets a user by its Id over the REST API.

Note: The current user must be a bot user.

impl UserId

fn created_at(&self) -> Timespec

Retrieves the time that the Id was created at.

Trait Implementations

impl Mentionable for UserId

fn mention(&self) -> String

impl FromStr for UserId

type Err = ()

The associated error which can be returned from parsing.

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

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

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

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

Formats the value using the given formatter.

impl Copy for UserId

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, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Eq for UserId

impl Hash for UserId

fn hash<__H: Hasher>(&self, __arg_0: &mut __H)

Feeds this value into the state given, updating the hasher as necessary.

fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher

Feeds a slice of this type into the state provided.

impl PartialOrd for UserId

fn partial_cmp(&self, __arg_0: &UserId) -> Option<Ordering>

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

fn lt(&self, __arg_0: &UserId) -> bool

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

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

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

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

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

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

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

impl Ord for UserId

fn cmp(&self, __arg_0: &UserId) -> Ordering

This method returns an Ordering between self and other.

impl From<u64> for UserId

fn from(id_as_u64: u64) -> UserId

Performs the conversion.

impl PartialEq for UserId

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

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

fn ne(&self, other: &Rhs) -> 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 ==.

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

This method tests for !=.