Struct twitter_stream::TwitterStreamBuilder

pub struct TwitterStreamBuilder<'a, T = Token> { /* fields omitted */ }

A builder for TwitterStream.

Example

extern crate twitter_stream;

use twitter_stream::{Token, TwitterStreamBuilder};
use twitter_stream::rt::{self, Future, Stream};

let token = Token::new("consumer_key", "consumer_secret", "access_key", "access_secret");

let future = TwitterStreamBuilder::sample(token)
    .timeout(None)
    .listen()
    .unwrap()
    .flatten_stream()
    .for_each(|json| {
        println!("{}", json);
        Ok(())
    })
    .map_err(|e| println!("error: {}", e));

rt::run(future);

Methods

impl<'a, C, A> TwitterStreamBuilder<'a, Token<C, A>> where     C: Borrow<str>,     A: Borrow<str>,

pub fn filter(token: Token<C, A>) -> Self

Create a builder for POST statuses/filter endpoint.

See the Twitter Developer Documentation for more information.

pub fn sample(token: Token<C, A>) -> Self

Create a builder for GET statuses/sample endpoint.

See the Twitter Developer Documentation for more information.

pub fn custom(method: RequestMethod, endpoint: Uri, token: Token<C, A>) -> Self

Constructs a builder for a Stream at a custom endpoint.

pub fn listen(&self) -> Result<FutureTwitterStream, TlsError>

Start listening on the Streaming API endpoint, returning a Future which resolves to a Stream yielding JSON messages from the API.

pub fn listen_with_client<Conn, B>(     &self,     client: &Client<Conn, B> ) -> FutureTwitterStream where     Conn: Connect + Sync + 'static,     Conn::Transport: 'static,     Conn::Future: 'static,     B: Default + From<Vec<u8>> + Payload + Send + 'static,     B::Data: Send,

Same as listen except that it uses client to make HTTP request to the endpoint.

impl<'a, C, A> TwitterStreamBuilder<'a, Token<C, A>>

pub fn method(&mut self, method: RequestMethod) -> &mut Self

Reset the HTTP request method to be used when connecting to the server.

pub fn endpoint(&mut self, endpoint: Uri) -> &mut Self

Reset the API endpoint URI to be connected.

pub fn token(&mut self, token: Token<C, A>) -> &mut Self

Reset the token to be used to log into Twitter.

pub fn timeout(     &mut self,     timeout: impl Into<Option<Duration>> ) -> &mut Self

Set a timeout for the stream. None means infinity.

pub fn stall_warnings(&mut self, stall_warnings: bool) -> &mut Self

Set whether to receive messages when in danger of being disconnected.

See the Twitter Developer Documentation for more information.

pub fn filter_level(     &mut self,     filter_level: impl Into<Option<FilterLevel>> ) -> &mut Self

Set the minimum filter_level Tweet attribute to receive. The default is FilterLevel::None.

See the Twitter Developer Documentation for more information.

pub fn language(     &mut self,     language: impl Into<Option<&'a str>> ) -> &mut Self

Set a comma-separated language identifiers to receive Tweets written in the specified languages only.

See the Twitter Developer Documentation for more information.

pub fn follow(     &mut self,     follow: impl Into<Option<&'a [u64]>> ) -> &mut Self

Set a list of user IDs to receive Tweets only from the specified users.

See the Twitter Developer Documentation for more information.

pub fn track(     &mut self,     track: impl Into<Option<&'a str>> ) -> &mut Self

A comma separated list of phrases to filter Tweets by.

See the Twitter Developer Documentation for more information.

pub fn locations(     &mut self,     locations: impl Into<Option<&'a [((f64, f64), (f64, f64))]>> ) -> &mut Self

Set a list of bounding boxes to filter Tweets by, specified by a pair of coordinates in the form of ((longitude, latitude), (longitude, latitude)) tuple.

See the Twitter Developer Documentation for more information.

pub fn count(     &mut self,     count: impl Into<Option<i32>> ) -> &mut Self

The count parameter. This parameter requires elevated access to use.

See the Twitter Developer Documentation for more information.

Trait Implementations

impl<'a, T: Clone> Clone for TwitterStreamBuilder<'a, T>

fn clone(&self) -> TwitterStreamBuilder<'a, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T: Debug> Debug for TwitterStreamBuilder<'a, T>

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

Formats the value using the given formatter.