Struct GetGateway

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

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().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().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.

Trait Implementations

impl IntoFuture for GetGateway<'_>

type Output = Result<Response<ConnectionInfo>, Error>

The output that the future will produce on completion.

type IntoFuture = ResponseFuture<ConnectionInfo>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.

impl TryIntoRequest for GetGateway<'_>

fn try_into_request(self) -> Result<Request, Error>

Try to convert a request builder into a raw Request.