Struct kuon::FollowersIds

pub struct FollowersIds<'a> { /* fields omitted */ }

Example

let api = kuon::TwitterAPI::new_using_env().await?;
let res = api.followers_ids().screen_name("rustlang").count(100).send().await?;

GET followers/ids

Returns a cursored collection of user IDs for every user following the specified user. At this time, results are ordered with the most recent following first — however, this ordering is subject to unannounced change and eventual consistency issues. Results are given in groups of 5,000 user IDs and multiple “pages” of results can be navigated through using the next_cursor value in subsequent requests. See Using cursors to navigate collections for more information. This method is especially powerful when used in conjunction with GET users / lookup, a method that allows you to convert user IDs into full user objects in bulk.

Resource Information

Q.	A.
Response formats	JSON
Requires authentication?	Yes
Rate limited?	Yes
Requests / 15-min window (user auth)	15
Requests / 15-min window (app auth)	15

https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-followers-ids

Implementations

impl<'a> FollowersIds<'a>

pub fn user_id(&mut self, user_id: u64) -> &mut Self

The ID of the user for whom to return results.

pub fn screen_name(&mut self, screen_name: impl Into<String>) -> &mut Self

The screen name of the user for whom to return results.

pub fn cursor(&mut self, cursor: i64) -> &mut Self

Causes the list of connections to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried. If no cursor is provided, a value of -1 will be assumed, which is the first “page.” The response from the API will include a previous_cursor and next_cursor to allow paging back and forth. See Using cursors to navigate collections for more information.

pub fn count(&mut self, count: u64) -> &mut Self

Specifies the number of IDs attempt retrieval of, up to a maximum of 5,000 per distinct request. The value of count is best thought of as a limit to the number of results to return. When using the count parameter with this method, it is wise to use a consistent count value across all requests to the same user’s collection. Usage of this parameter is encouraged in environments where all 5,000 IDs constitutes too large of a response.

impl<'a> FollowersIds<'a>

pub async fn send(&self) -> Result<FollowersIdsResult, Error>

Trait Implementations

impl<'a> Clone for FollowersIds<'a>

fn clone(&self) -> FollowersIds<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for FollowersIds<'a>

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

Formats the value using the given formatter.