[−][src]Struct egg_mode::user::TwitterUser
Represents a Twitter user.
Field-level documentation is mostly ripped wholesale from Twitter's user documentation.
The fields present in this struct can be divided up into a few sections: Profile Information and Settings.
Profile Information
Information here can be considered part of the user's profile. These fields are the "obvious" visible portion of a profile view.
id
screen_name
name
verified
protected
description
location
url
statuses_count
friends_count
followers_count
favourites_count
listed_count
profile_image_url
/profile_image_url_https
profile_banner_url
Settings Information
Information here can be used to alter the UI around this user, or to provide further metadata that may not necessarily be user-facing.
contributors_enabled
created_at
default_profile_image
follow_request_sent
default_profile
,profile_background_color
,profile_background_image_url
,profile_background_image_url_https
,profile_background_tile
,profile_link_color
,profile_sidebar_border_color
,profile_sidebar_fill_color
,profile_text_color
,profile_use_background_image
: These fields can be used to theme a user's profile page to look like the settings they've set on the Twitter website.geo_enabled
is_translator
lang
show_all_inline_media
time_zone
/utc_offset
withheld_in_countries
/withheld_scope
Fields
contributors_enabled: bool
Indicates this user has an account with "contributor mode" enabled, allowing
for Tweets issued by the user to be co-authored by another account. Rarely true
.
created_at: DateTime<Utc>
The UTC timestamp for when this user account was created on Twitter.
default_profile: bool
When true, indicates that this user has not altered the theme or background of their user profile.
default_profile_image: bool
When true, indicates that the user has not uploaded their own avatar and a default egg avatar is used instead.
description: Option<String>
The user-defined string describing their account.
entities: UserEntities
Link information that has been parsed out of the url
or description
fields given by the
user.
favourites_count: i32
The number of tweets this user has favorited or liked in the account's lifetime. The term "favourites" and its British spelling are used for historical reasons.
follow_request_sent: Option<bool>
When true, indicates that the authenticating user has issued a follow request to this protected account.
followers_count: i32
The number of followers this account has.
In certain server-stress conditions, this may temporarily mistakenly return 0.
friends_count: i32
The number of users this account follows, aka its "followings".
In certain server-stress conditions, this may temporarily mistakenly return 0.
geo_enabled: bool
Indicates whether this user as enabled their tweets to be geotagged.
If this is set for the current user, then they can attach geographic data when posting a new Tweet.
id: u64
Unique identifier for this user.
is_translator: bool
Indicates whether the user participates in Twitter's translator community.
lang: Option<String>
Language code for the user's self-declared interface language.
Codes are formatted as a language tag from BCP 47. Only indicates the user's interface language, not necessarily the content of their Tweets.
listed_count: i32
The number of public lists the user is a member of.
location: Option<String>
The user-entered location field from their profile. Not necessarily parseable or even a location.
name: String
The user-entered display name.
profile_background_color: String
The hex color chosen by the user for their profile background.
profile_background_image_url: Option<String>
A URL pointing to the background image chosen by the user for their profile. Uses HTTP as the protocol.
profile_background_image_url_https: Option<String>
A URL pointing to the background image chosen by the user for their profile. Uses HTTPS as the protocol.
profile_background_tile: Option<bool>
Indicates whether the user's profile_background_image_url
should be tiled when
displayed.
A URL pointing to the banner image chosen by the user. Uses HTTPS as the protocol.
This is a base URL that a size specifier can be appended onto to get variously sized images, with size specifiers according to Profile Images and Banners.
profile_image_url: String
A URL pointing to the user's avatar image. Uses HTTP as the protocol. Size specifiers can be used according to Profile Images and Banners.
profile_image_url_https: String
A URL pointing to the user's avatar image. Uses HTTPS as the protocol. Size specifiers can be used according to Profile Images and Banners.
profile_link_color: String
The hex color chosen by the user to display links in the Twitter UI.
The hex color chosen by the user to display sidebar borders in the Twitter UI.
The hex color chosen by the user to display sidebar backgrounds in the Twitter UI.
profile_text_color: String
The hex color chosen by the user to display text in the Twitter UI.
profile_use_background_image: bool
Indicates whether the user wants their uploaded background image to be used.
protected: bool
Indicates whether the user is a protected account.
screen_name: String
The screen name or handle identifying this user.
Screen names are unique per-user but can be changed. Use id
for an immutable identifier
for an account.
Typically a maximum of 15 characters long, but older accounts may exist with longer screen names.
show_all_inline_media: Option<bool>
Indicates that the user would like to see media inline. "Somewhat disused."
status: Option<Box<Tweet>>
If possible, the most recent tweet or retweet from this user.
"In some circumstances, this data cannot be provided and this field will be omitted, null, or empty." Do not depend on this field being filled. Also note that this is actually their most-recent tweet, not the status pinned to their profile.
"Perspectival" items within this tweet that depend on the authenticating user may not be completely reliable in this embed.
statuses_count: i32
The number of tweets (including retweets) posted by this user.
time_zone: Option<String>
The full name of the time zone the user has set their UI preference to.
url: Option<String>
The website link given by this user in their profile.
utc_offset: Option<i32>
The UTC offset of time_zone
in minutes.
verified: bool
Indicates whether this user is a verified account.
withheld_in_countries: Option<Vec<String>>
When present, lists the countries this user has been withheld from.
withheld_scope: Option<String>
When present, indicates whether the content being withheld is a "status" or "user".
Trait Implementations
impl Clone for TwitterUser
[src]
fn clone(&self) -> TwitterUser
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for TwitterUser
[src]
impl<'de> Deserialize<'de> for TwitterUser
[src]
fn deserialize<D>(deser: D) -> Result<TwitterUser, D::Error> where
D: Deserializer<'de>,
[src]
D: Deserializer<'de>,
Auto Trait Implementations
impl RefUnwindSafe for TwitterUser
impl Send for TwitterUser
impl Sync for TwitterUser
impl Unpin for TwitterUser
impl UnwindSafe for TwitterUser
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: Deserialize<'de>,
[src]
T: Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,