Struct kuon::HomeTimeline

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

Example

let api = kuon::TwitterAPI::new_using_env().await?;
let res = api.home_timeline().count(10).send().await?;
for tweet in res {
    println!("{}", tweet.text);
}

GET statuses/home_timeline

Returns a collection of the most recent Tweets and Retweets posted by the authenticating user and the users they follow. The home timeline is central to how most users interact with the Twitter service. Up to 800 Tweets are obtainable on the home timeline. It is more volatile for users that follow many users or follow users who Tweet frequently.

See Working with Timelines for instructions on traversing timelines efficiently.

Resource Information

Q.	A.
Requires authentication?	Yes (user context only)
Rate limited?	Yes
Requests / 15-min window (user auth)	15

https://developer.twitter.com/en/docs/twitter-api/v1/tweets/timelines/api-reference/get-statuses-home_timeline

Implementations

impl<'a> HomeTimeline<'a>

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

Specifies the number of records to retrieve. Must be less than or equal to 200. Defaults to 20. The value of count is best thought of as a limit to the number of tweets to return because suspended or deleted content is removed after the count has been applied.

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

Returns results with an ID greater than (that is, more recent than) the specified ID. There are limits to the number of Tweets which can be accessed through the API. If the limit of Tweets has occured since the since_id, the since_id will be forced to the oldest ID available.

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

Returns results with an ID less than (that is, older than) or equal to the specified ID.

pub fn trim_user(&mut self, trim_user: impl Into<bool>) -> &mut Self

When set to either true , t or 1 , each Tweet returned in a timeline will include a user object including only the status authors numerical ID. Omit this parameter to receive the complete user object.

pub fn exclude_replies(&mut self, exclude_replies: impl Into<bool>) -> &mut Self

This parameter will prevent replies from appearing in the returned timeline. Using exclude_replies with the count parameter will mean you will receive up-to count Tweets — this is because the count parameter retrieves that many Tweets before filtering out retweets and replies.

pub fn include_entities(
    &mut self,
    include_entities: impl Into<bool>
) -> &mut Self

The entities node will not be included when set to false.

impl<'a> HomeTimeline<'a>

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

Trait Implementations

impl<'a> Clone for HomeTimeline<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for HomeTimeline<'a>

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

Formats the value using the given formatter.