Enum screeps_api::websocket::ScreepsMessage

pub enum ScreepsMessage<'a> {
    AuthFailed,
    AuthOk {
        new_token: Token,
    },
    ServerTime {
        time: u64,
    },
    ServerProtocol {
        protocol: u32,
    },
    ServerPackage {
        package: u32,
    },
    ChannelUpdate {
        update: ChannelUpdate<'a>,
    },
    Other(Cow<'a, str>),
}

A parsed message.

Variants

AuthFailed

Authentication failed.

AuthOk

Authentication successful!

Fields of AuthOk

new_token: Token

The new token to store.

ServerTime

On initial connection, the server reports its own time.

Fields of ServerTime

time: u64

The server time.

ServerProtocol

On initial connection, the server reports a protocol version.

Fields of ServerProtocol

protocol: u32

The protocol version.

ServerPackage

On initial connection, the server reports a "package" number.

Fields of ServerPackage

package: u32

I'm not sure what this means at all.

ChannelUpdate

An update on one of the channels.

Fields of ChannelUpdate

update: ChannelUpdate<'a>

The update.

Other(Cow<'a, str>)

Another kind of message.

Methods

impl ScreepsMessage<'static>

pub fn parse<T: AsRef<str> + ?Sized>(message: &T) -> Self

Parses the internal message from a SockJS message into a meaningful type.

Trait Implementations

impl<'a> Clone for ScreepsMessage<'a>

fn clone(&self) -> ScreepsMessage<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ScreepsMessage<'a>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.