Enum ChildMessage 

pub enum ChildMessage {
    Ready,
    Metric {
        name: String,
        value: f64,
        metric_type: Option<MetricType>,
        labels: BTreeMap<String, String>,
        help: Option<String>,
    },
    ActionReply {
        action: String,
        body: String,
        id: Option<u64>,
    },
    LambLabel {
        pid: u32,
        label: LambLabel,
    },
    Note {
        name: String,
        value: f64,
    },
}

Child -> daemon shepherd-channel message (spec §7, kebab-case kinds)

Variants

Ready

{"kind":"ready"}: readiness signal (wait_ready gate)

Metric

Custom metric sample

Names and labels carry no grammar check here: the metrics dog enforces that when it reads them. Do not add a half check to this crate.

Fields

name: String

Metric name

value: f64

Metric value

metric_type: Option<MetricType>

What kind of number this is. Absent on the wire means gauge.

Wire key type: a Rust field named kind would collide with the tag. An unknown string fails to decode, so the shepherd drops the frame as malformed rather than guessing a kind.

labels: BTreeMap<String, String>

Labels for the sample. An absent key and an empty map are the same message.

help: Option<String>

Free-text help for the sample

ActionReply

Reply to a daemon-initiated action

Fields

action: String

The action name this replies to

body: String

Free-form reply body

id: Option<u64>

The id of the ShepherdMessage::Action this answers, echoed back verbatim. None when the app did not echo it. Then the daemon falls back to matching by name and order.

LambLabel

Names one of this sheep’s lambs for shep describe and lookout.

Shown only while pid is in the sheep’s own process tree. An empty label clears the one pid had.

Fields

pid: u32

The lamb’s pid, as the app’s own spawn call reported it

label: LambLabel

What describe shows beside the lamb’s executable name

Note

A name and a number for a dog, published as channel.note

Not a metric sample: the metrics dog never reads one. No grammar check on name, no labels and no help.

Fields

name: String

Whatever the app and the dog agree on

value: f64

The number that goes with name

Trait Implementations

impl Clone for ChildMessage

fn clone(&self) -> ChildMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChildMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChildMessage

fn deserialize<__D>( __deserializer: __D, ) -> Result<ChildMessage, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ChildMessage

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ChildMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ChildMessage