Struct GatewayClient 

pub struct GatewayClient { /* private fields */ }

Connected client before its command and event halves are separated.

Implementations

impl GatewayClient

pub async fn connect( endpoint: &Endpoint, token: &str, client_kind: ClientKind, ) -> Result<Self>

Authenticates an existing client and leaves the gateway Ready frame for events.

Errors

Returns an error if the transport fails or returns invalid data.

pub async fn connect_with( endpoint: &Endpoint, token: &str, client_kind: ClientKind, options: &mut ConnectOptions, ) -> Result<Self>

Self::connect with a catalog hint and pipelined requests, which options holds again afterwards, whether or not the connection succeeded.

Errors

Returns an error if the transport fails or returns invalid data.

pub async fn pair( endpoint: &Endpoint, code: impl Into<String>, client_label: impl Into<String>, client_kind: ClientKind, ) -> Result<(Self, PairedClient)>

Consumes a pending pairing code and returns a connected independent client.

Errors

Returns an error if authentication fails or its stored state is invalid.

pub fn into_parts(self) -> (GatewaySender, GatewayEvents)

Separates the clonable command writer from the single event reader.