Struct CommandEnvelope 

pub struct CommandEnvelope {
    pub command_id: Uuid,
    pub actor: Option<String>,
    pub command: CombatCommand,
}

A command plus the metadata that makes it trackable. command_id is chosen by the client: the server tags the resulting events with it (so the client knows its prediction was confirmed) and ignores repeats (so resending after a dropped connection is safe).

Fields

command_id: Uuid

actor: Option<String>

Free-text name of whoever issued it, for the log (“DM”, “Travis”).

command: CombatCommand

Implementations

impl CommandEnvelope

pub fn new(command: CombatCommand) -> Self

An envelope for command, with a fresh id.

pub fn by(self, actor: impl Into<String>) -> Self

The same, saying who sends it (the server puts the device’s name there anyway).

Trait Implementations

impl Clone for CommandEnvelope

fn clone(&self) -> CommandEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for CommandEnvelope

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for CommandEnvelope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommandEnvelope

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CommandEnvelope

fn eq(&self, other: &CommandEnvelope) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CommandEnvelope

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for CommandEnvelope

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference [utoipa::openapi::schema::Schema]s for this type.

impl Eq for CommandEnvelope

impl StructuralPartialEq for CommandEnvelope