Enum ShepherdMessage 

pub enum ShepherdMessage {
    Shutdown,
    Action {
        name: String,
        params: Option<String>,
        id: u64,
    },
}

Daemon→child message

Variants

Shutdown

Graceful-stop request (shutdown_with_message)

Action

Custom action dispatch

Fields

name: String

The action name

params: Option<String>

Argument text for the action, passed through to the child verbatim; None when the action was triggered without any.

Absent from the serialized form when None, and absent on the wire deserializes back to None, so a message carrying no arguments is byte-identical to one from before this field existed. That is what makes the field additive on a channel that has no version to negotiate — see the spec’s §9 note on trigger.

One opaque string, not structured data: the daemon never reads it, and an app that wants JSON, a flag list or a bare word parses it in the grammar it already has.

id: u64

This dispatch’s correlation id, unique for the life of the daemon. Echo it back on your ChildMessage::ActionReply as id and the daemon matches your answer to this exact request rather than to its name.

Always present, unlike params: an app that ignores the key is unaffected, and an app that wants to echo must never have to handle its absence. u64 and monotonically increasing, but neither of those is a promise an app should lean on — treat it as an opaque token to hand back.

Trait Implementations

impl Clone for ShepherdMessage

fn clone(&self) -> ShepherdMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShepherdMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ShepherdMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ShepherdMessage

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ShepherdMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ShepherdMessage