Struct IterBuffer

pub struct IterBuffer<R, T> { /* private fields */ }

Common parts to all requests that are used for creating iterators.

End-users should obtain particular instances of this type via client methods.

Implementations

impl IterBuffer<GetInlineBotResults, InlineResult>

pub fn chat<C: Into<PackedChat>>(self, chat: C) -> Self

Indicate the bot the chat where this inline query will be sent to.

Some bots use this information to return different results depending on the type of the chat, and some even “need” it to give useful results.

pub async fn next(&mut self) -> Result<Option<InlineResult>, InvocationError>

Return the next InlineResult from the internal buffer, filling the buffer previously if it’s empty.

Returns None if the limit is reached or there are no results left.

impl IterBuffer<GetDialogs, Dialog>

pub async fn total(&mut self) -> Result<usize, InvocationError>

Determines how many dialogs there are in total.

This only performs a network call if next has not been called before.

pub async fn next(&mut self) -> Result<Option<Dialog>, InvocationError>

Return the next Dialog from the internal buffer, filling the buffer previously if it’s empty.

Returns None if the limit is reached or there are no dialogs left.

impl IterBuffer<GetHistory, Message>

pub fn offset_id(self, offset: i32) -> Self

pub fn max_date(self, offset: i32) -> Self

pub async fn total(&mut self) -> Result<usize, InvocationError>

Determines how many messages there are in total.

This only performs a network call if next has not been called before.

pub async fn next(&mut self) -> Result<Option<Message>, InvocationError>

Return the next Message from the internal buffer, filling the buffer previously if it’s empty.

Returns None if the limit is reached or there are no messages left.

impl IterBuffer<Search, Message>

pub fn offset_id(self, offset: i32) -> Self

pub fn query(self, query: &str) -> Self

Changes the query of the search. Telegram servers perform a somewhat fuzzy search over this query (so a word in singular may also return messages with the word in plural, for example).

pub fn sent_by_self(self) -> Self

Restricts results to messages sent by the logged-in user

pub fn min_date(self, date_time: &DateTime<FixedOffset>) -> Self

Returns only messages with date bigger than date_time.

use chrono::DateTime;

// Search messages sent after Jan 1st, 2021
let min_date = DateTime::parse_from_rfc3339("2021-01-01T00:00:00-00:00").unwrap();

let mut messages = client.search_messages(&chat).min_date(&min_date);

pub fn max_date(self, date_time: &DateTime<FixedOffset>) -> Self

Returns only messages with date smaller than date_time

use chrono::DateTime;

// Search messages sent before Dec, 25th 2022
let max_date = DateTime::parse_from_rfc3339("2022-12-25T00:00:00-00:00").unwrap();

let mut messages = client.search_messages(&chat).max_date(&max_date);

pub fn filter(self, filter: MessagesFilter) -> Self

Changes the media filter. Only messages with this type of media will be fetched.

pub async fn total(&mut self) -> Result<usize, InvocationError>

Determines how many messages there are in total.

This only performs a network call if next has not been called before.

pub async fn next(&mut self) -> Result<Option<Message>, InvocationError>

Return the next Message from the internal buffer, filling the buffer previously if it’s empty.

Returns None if the limit is reached or there are no messages left.

impl IterBuffer<SearchGlobal, Message>

pub fn offset_id(self, offset: i32) -> Self

pub fn query(self, query: &str) -> Self

Changes the query of the search. Telegram servers perform a somewhat fuzzy search over this query (so a word in singular may also return messages with the word in plural, for example).

pub fn filter(self, filter: MessagesFilter) -> Self

Changes the media filter. Only messages with this type of media will be fetched.

pub async fn total(&mut self) -> Result<usize, InvocationError>

Determines how many messages there are in total.

This only performs a network call if next has not been called before.

pub async fn next(&mut self) -> Result<Option<Message>, InvocationError>

Return the next Message from the internal buffer, filling the buffer previously if it’s empty.

Returns None if the limit is reached or there are no messages left.

impl<R, T> IterBuffer<R, T>

pub fn limit(self, n: usize) -> Self

Change how many items will be returned from the iterator.

Using limit instead of take on the iterator is useful because outgoing requests can ask for less items from the server to only fetch what’s needed.