Struct tgbot::types::GetUpdates

pub struct GetUpdates { /* private fields */ }

Returns incoming updates using long polling.

Implementations

impl GetUpdates

pub fn add_allowed_update(self, value: AllowedUpdate) -> Self

Adds a type of an update you want your bot to receive.

Arguments

• value - The type to add.

pub fn with_allowed_updates<T>(self, value: T) -> Self

where T: IntoIterator<Item = AllowedUpdate>,

Sets a new list of allowed updates.

Arguments

• value - List of the types of updates you want your bot to receive.

For example, specify [AllowedUpdate::Message, AllowedUpdate::EditedChannelPost] to only receive updates of these types. Specify an empty list to receive all updates regardless of type (default). If not specified, the previous setting will be used. Please note that this parameter doesn’t affect updates created before the call to the method, so unwanted updates may be received for a short period of time.

pub fn with_limit(self, value: Integer) -> Self

Sets a new limit.

Arguments

• value - Limit of the number of updates to be retrieved; 1—100; default - 100.

pub fn with_offset(self, value: Integer) -> Self

Sets a new offset.

Arguments

• value - Identifier of the first update to be returned.

Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as the method is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will forgotten.

pub fn with_timeout(self, value: Duration) -> Self

Sets a new timeout.

Arguments

• value - Timeout for long polling; default - 0, i.e. usual short polling; should be positive; short polling should be used for testing purposes only.

Trait Implementations

impl Clone for GetUpdates

fn clone(&self) -> GetUpdates

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetUpdates

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

Formats the value using the given formatter.

impl Default for GetUpdates

fn default() -> GetUpdates

Returns the “default value” for a type.

impl Method for GetUpdates

type Response = Vec<Update>

The type representing a successful result in an API response.

fn into_payload(self) -> Payload

Converts the method into a payload for an HTTP request.

impl Serialize for GetUpdates

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.