caryatid_module_spy

Crates.iocaryatid_module_spy
lib.rscaryatid_module_spy
version0.12.0
created_at2025-03-24 15:27:00.018495+00
updated_at2025-06-18 15:02:07.546174+00
descriptionSpy module for Caryatid
homepage
repository
max_upload_size
id1603896
size38,365
Paul Clark (sandtreader)

documentation

README

Standard Spy module for Caryatid

The Spy module provides a way to observe any messages on the bus. It simply subscribes to a topic and logs the received messages.

Configuration

The Spy module is configured with a topic to spy on:

[module.spy]
topic = mi5.top.secret

Messages

The spy module can receive any message types and logs them (as info) using their Debug trait.

Registration

The Spy module needs to be parameterised with the type of the outer message enum

#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub enum Message {
    None(()),
    ... all my messages ...
}

Then within your main.rs you would register the Spy module into the process like this:

    Spy::<Message>::register(&mut process);
Commit count: 0

cargo fmt