Struct twilight_http::request::prelude::GetGateway

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

Get information about the gateway, optionally with additional information detailing the number of shards to use and sessions remaining.

Examples

Get the gateway connection URL without bot information:

use twilight_http::Client;

let client = Client::new("my token".to_owned());

let info = client.gateway().exec().await?.model().await?;

Get the gateway connection URL with additional shard and session information, which requires specifying a bot token:

use twilight_http::Client;

let client = Client::new("my token".to_owned());

let info = client.gateway().authed().exec().await?.model().await?;

println!("URL: {}", info.url);
println!("Recommended shards to use: {}", info.shards);

Implementations

impl<'a> GetGateway<'a>

pub const fn authed(self) -> GetGatewayAuthed<'a>

Call to authenticate this request.

Returns additional information: the recommended number of shards to use, and information on the current session start limit.

pub fn exec(self) -> ResponseFuture<ConnectionInfo>

Execute the request, returning a future resolving to a Response.