Struct spectacles_gateway::Shard

pub struct Shard {
    pub token: String,
    pub info: [usize; 2],
    pub presence: ClientPresence,
    pub session_id: Option<String>,
    pub interval: Option<u64>,
    pub sender: Arc<Mutex<UnboundedSender<WebsocketMessage>>>,
    pub stream: Arc<Mutex<Option<SplitStream<WebSocketStream<TungsteniteStream<TokioTcpStream, TlsStream<TokioTcpStream>>>>>>>,
    pub heartbeat: Arc<Mutex<Heartbeat>>,
    // some fields omitted
}

A Spectacles Gateway shard.

Fields

token: String

The bot token that this shard will use.

info: [usize; 2]

The shard's info. Includes the shard's ID and the total amount of shards.

presence: ClientPresence

The currently active presence for this shard.

session_id: Option<String>

The session ID of this shard, if applicable.

interval: Option<u64>

The interval at which a heartbeat is made.

sender: Arc<Mutex<UnboundedSender<WebsocketMessage>>>

The channel which is used to send websocket messages.

stream: Arc<Mutex<Option<SplitStream<WebSocketStream<TungsteniteStream<TokioTcpStream, TlsStream<TokioTcpStream>>>>>>>

The shard's message stream, which is used to receive messages.

heartbeat: Arc<Mutex<Heartbeat>>

This shard's current heartbeat.

Methods

impl Shard

pub fn new(
    token: String,
    info: [usize; 2],
    ws_uri: String
) -> impl Future<Item = Shard, Error = Error>

Creates a new Discord Shard, with the provided token.

pub fn fulfill_gateway(&mut self, packet: ReceivePacket) -> Result<ShardAction>

pub fn identify(&mut self) -> Result<()>

Identifies a shard with Discord.

pub fn autoreconnect(
    &mut self
) -> Box<dyn Future<Item = (), Error = Error> + Send>

Attempts to automatically reconnect the shard to Discord.

pub fn reconnect(&mut self) -> impl Future<Item = (), Error = Error> + Send

Makes a request to reconnect the shard.

pub fn resume(&mut self) -> impl Future<Item = (), Error = Error> + Send

Resumes a shard's past session.

pub fn resolve_packet(&self, mess: &WebsocketMessage) -> Result<ReceivePacket>

Resolves a Websocket message into a ReceivePacket struct.

pub fn send_payload<T: SendablePacket>(&self, payload: T) -> Result<()>

Sends a payload to the Discord Gateway.

pub fn change_status(&mut self, status: Status) -> Result<()>

Change the status of the current shard.

pub fn change_activity(&mut self, activity: ClientActivity) -> Result<()>

Change the activity of the current shard.

pub fn change_presence(&mut self, presence: ClientPresence) -> Result<()>

Change the presence of the current shard.

Trait Implementations

impl Clone for Shard

fn clone(&self) -> Shard

Returns a copy of the value.

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

Performs copy-assignment from source.