Enum BusEvent 

#[non_exhaustive]
pub enum BusEvent {
    Process {
        event: ProcessEventKind,
        info: ProcessInfo,
        manually: bool,
        at_ms: u64,
    },
    LogOut {
        id: u32,
        line: String,
    },
    LogErr {
        id: u32,
        line: String,
    },
    Channel {
        id: u32,
        message: ChildMessage,
    },
    Dropped {
        count: u64,
    },
    DaemonShutdown,
    DogConfigChanged {
        dog: String,
    },
    DogSheepSettingsChanged {
        dog: String,
        sheep: String,
    },
}

One event on the daemon bus

Adjacently tagged: event discriminator, data wrapper. Subscription topics are the dotted strings from BusEvent::topic (process.exit, log.out, daemon.*); the daemon’s filter globs against them.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Process

Lifecycle event for one sheep

Fields

event: ProcessEventKind

What happened

info: ProcessInfo

Sheep snapshot at event time

manually: bool

True when a user action caused it

at_ms: u64

Unix millis

LogOut

One stdout line from a sheep

Fields

id: u32

Sheep id

line: String

The line (no trailing newline)

LogErr

One stderr line from a sheep

Fields

id: u32

Sheep id

line: String

The line

Channel

One message a sheep wrote on its shepherd channel (fd 3).

Child -> shepherd only: the shepherd’s own writes (a shutdown message, a dispatched action) are reported elsewhere, by process.stop and Response::Triggered.

message is the app’s own text, whole and unredacted. The daemon adds nothing of its own; app-provided text must be safe for every subscriber, since it is broadcast verbatim.

Fields

id: u32

The sheep that wrote it.

message: ChildMessage

The message, exactly as it came off fd 3.

Dropped

The bounded queue dropped this many events for this subscriber

Fields

count: u64

Dropped-event count since last notice

DaemonShutdown

Daemon is shutting down

DogConfigChanged

A dog’s section in dogs.toml changed. Published under config.dog.<name>, so a dog subscribes to its own name and hears nobody else’s.

Carries only the dog’s name, nothing else: the bus is a broadcast, and a [bark] section can hold a webhook URL as a bearer credential (why DogSectionToml redacts its own Debug). A dog that wants the values re-asks with Request::DogConfig, which answers only that dog’s own section.

Fields

dog: String

The dog whose section changed.

DogSheepSettingsChanged

A dog’s [app.dogs.<name>] table changed on one sheep. Published under config.sheep.<dog>, so a dog subscribes to its own name and hears nobody else’s, the way Self::DogConfigChanged does for dogs.toml.

Fires once per dog and sheep for a change that adds, removes or edits that sheep’s table for dog: a name gaining its first table, the last instance of such a name being deleted, or a load, Request::SetSheepDogSettings or --reset changing one. Never for a handover, since that changes no answer.

Carries only the sheep’s name and the dog’s: a table can hold a credential, the same reason Self::DogConfigChanged carries only the dog’s own name. A dog that wants the values re-asks with Request::DogSheepSettings, which answers with that dog’s tables.

Fields

dog: String

The dog whose table changed.

sheep: String

The sheep whose table changed.

Implementations

impl BusEvent

pub fn topic(&self) -> Cow<'static, str>

The dotted subscription topic for this event (spec §6 grammar)

A Cow rather than a &'static str, because two topics are not fixed: Self::DogConfigChanged and Self::DogSheepSettingsChanged name their dog in the topic itself, which is what lets a dog subscribe to its own config and hear nobody else’s. Every other variant is still a borrowed literal and allocates nothing.

Trait Implementations

impl Clone for BusEvent

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BusEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BusEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BusEvent

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for BusEvent

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 BusEvent