Struct egg_mode::list::List

pub struct List {
    pub name: String,
    pub user: TwitterUser,
    pub slug: String,
    pub id: u64,
    pub subscriber_count: u64,
    pub member_count: u64,
    pub full_name: String,
    pub description: String,
    pub uri: String,
    pub created_at: DateTime<Utc>,
}

Represents the metadata for a list.

Because of the myriad ways to reference a list, there are a few seemingly-redundant fields on here. It’s worthwhile to understand all the referential fields:

• name is the human-readable name of the list. Notably, this can contain spaces and uppercase letters.
• slug is simply name converted to a format that can be put into a URL and used to reference the list for API calls.
• full_name is how you’d link the list as a @mention, in the form @screen_name/slug.
• id is the numeric ID, which can be used with ListID::from_id to make a ListID for the list.
• uri is how you assemble a link to the list. Start with "https://twitter.com", concat this field to the end, and you have a full URL. Note that the field does start with its own slash.
• user is a mostly-populated TwitterUser corresponding to the creator of the list. If you combine user.screen_name or user.id with slug, you can send them to ListID::from_slug to make a ListID for the list.

Fields

name: String

The name of the list.

user: TwitterUser

The user who created the list.

slug: String

The “slug” of a list, that can be combined with its creator’s UserID to refer to the list.

id: u64

The numeric ID of the list.

subscriber_count: u64

The number of accounts “subscribed” to the list, for whom it will appear in their collection of available lists.

member_count: u64

The number of accounts added to the list.

full_name: String

The full name of the list, preceded by @, that can be used to link to the list as part of a tweet, direct message, or other place on Twitter where @mentions are parsed.

description: String

The description of the list, as entered by its creator.

uri: String

The full name of the list, preceded by /, that can be preceded with https://twitter.com to create a link to the list.

created_at: DateTime<Utc>

UTC timestamp of when the list was created.

Trait Implementations

impl Clone for List

fn clone(&self) -> List

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for List

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for List

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.