Enum screeps_api::websocket::UserConsoleUpdate

pub enum UserConsoleUpdate {
    Messages {
        log_messages: Vec<String>,
        result_messages: Vec<String>,
        shard: Option<String>,
    },
    Error {
        message: String,
        shard: Option<String>,
    },
}

Update for a user's log messages during the last tick.

Variants

Messages

All log messages which occurred during the last tick. Will always be sent once per tick unless an error occurs and this would be empty.

Fields of Messages

log_messages: Vec<String>

All messages the screeps script code logged last tick.

result_messages: Vec<String>

All result strings from console commands executed last tick.

shard: Option<String>

The shard the update is from

Error

An error occurred in the user script. May be sent multiple times per tick, and will not be sent unless an error did occur.

Fields of Error

message: String

The error which occurred.

shard: Option<String>

The shard the update is from

Methods

impl UserConsoleUpdate

pub fn shard(&self) -> Option<&str>

Gets the shard this update is for.

Trait Implementations

impl Clone for UserConsoleUpdate

fn clone(&self) -> UserConsoleUpdate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserConsoleUpdate

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

Formats the value using the given formatter.

impl Hash for UserConsoleUpdate

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<'de> Deserialize<'de> for UserConsoleUpdate

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.