Struct sync15::clients::record::CommandRecord

[+] Show declaration

pub struct CommandRecord {
    pub name: String,
    pub args: Vec<String>,
    pub flow_id: Option<String>,
}

[−] Expand description

The serialized form of a client command.

Fields

name: String

[−] Expand description

The command name. This is a string, not an enum, because we want to round-trip commands that we don't support yet.

args: Vec<String>

[−] Expand description

Extra, command-specific arguments. Note that we must send an empty array if the command expects no arguments.

flow_id: Option<String>

[−] Expand description

Some commands, like repair, send a "flow ID" that other cliennts can record in their telemetry. We don't currently send commands with flow IDs, but we round-trip them.

Implementations

impl CommandRecord[−]

pub fn as_command(&self) -> Option<Command>[−]

Converts a serialized command into one that we can apply. Returns None if we don't support the command.

Trait Implementations

impl Clone for CommandRecord[+]

[+] Show hidden undocumented items

fn clone(&self) -> CommandRecord[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for CommandRecord[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommandRecord[+]

[+] Show hidden undocumented items

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, [−]

Deserialize this value from the given Serde deserializer.

impl Eq for CommandRecord

impl From<Command> for CommandRecord[+]

[+] Show hidden undocumented items

fn from(command: Command) -> CommandRecord[−]

Performs the conversion.

impl Hash for CommandRecord[+]

[+] Show hidden undocumented items

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 PartialEq<CommandRecord> for CommandRecord[+]

[+] Show hidden undocumented items

fn eq(&self, other: &CommandRecord) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CommandRecord) -> bool[−]

This method tests for !=.

impl Serialize for CommandRecord[+]

[+] Show hidden undocumented items

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, [−]

Serialize this value into the given Serde serializer.

impl StructuralEq for CommandRecord

impl StructuralPartialEq for CommandRecord