Struct twilight_http::request::GetGateway
source · [−]pub struct GetGateway<'a> { /* private fields */ }
Expand description
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
sourceimpl<'a> GetGateway<'a>
impl<'a> GetGateway<'a>
sourcepub const fn authed(self) -> GetGatewayAuthed<'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.
sourcepub fn exec(self) -> ResponseFuture<ConnectionInfo>ⓘNotable traits for ResponseFuture<T>impl<T: Unpin> Future for ResponseFuture<T> type Output = Result<Response<T>, Error>;
pub fn exec(self) -> ResponseFuture<ConnectionInfo>ⓘNotable traits for ResponseFuture<T>impl<T: Unpin> Future for ResponseFuture<T> type Output = Result<Response<T>, Error>;
Execute the request, returning a future resolving to a Response
.
Trait Implementations
sourceimpl TryIntoRequest for GetGateway<'_>
impl TryIntoRequest for GetGateway<'_>
Auto Trait Implementations
impl<'a> !RefUnwindSafe for GetGateway<'a>
impl<'a> Send for GetGateway<'a>
impl<'a> Sync for GetGateway<'a>
impl<'a> Unpin for GetGateway<'a>
impl<'a> !UnwindSafe for GetGateway<'a>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more