Struct Snapshot 

pub struct Snapshot {
    pub version: SchemaVersion,
    pub timestamp_ms: u64,
    pub modules: BTreeMap<String, ModuleMetrics>,
}

A point-in-time snapshot of message bus metrics.

This is the top-level type that captures the state of all modules in a message bus system. Snapshots are typically emitted periodically (e.g., every second) and consumed by monitoring tools like buswatch.

Example

use buswatch_types::Snapshot;
use std::time::Duration;

let snapshot = Snapshot::builder()
    .module("order-service", |m| {
        m.read("orders.new", |r| r.count(500).backlog(10))
         .write("orders.validated", |w| w.count(495))
    })
    .build();

// Serialize with serde (requires "serde" feature)
// let json = serde_json::to_string(&snapshot)?;

Fields

version: SchemaVersion

Schema version for forward compatibility.

timestamp_ms: u64

Unix timestamp in milliseconds when this snapshot was taken.

modules: BTreeMap<String, ModuleMetrics>

Metrics for each module, keyed by module name.

Implementations

impl Snapshot

pub fn new() -> Self

Create a new snapshot with the current timestamp.

pub fn with_timestamp(timestamp_ms: u64) -> Self

Create a new snapshot with a specific timestamp.

pub fn builder() -> SnapshotBuilder

Create a builder for constructing snapshots.

pub fn is_empty(&self) -> bool

Check if the snapshot is empty (no modules).

pub fn len(&self) -> usize

Number of modules in the snapshot.

pub fn get(&self, module: &str) -> Option<&ModuleMetrics>

Get metrics for a specific module.

pub fn iter(&self) -> impl Iterator<Item = (&String, &ModuleMetrics)>

Iterate over all modules.

pub fn total_reads(&self) -> u64

Total messages read across all modules.

pub fn total_writes(&self) -> u64

Total messages written across all modules.

Trait Implementations

impl Clone for Snapshot

fn clone(&self) -> Snapshot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Snapshot

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

Formats the value using the given formatter.

impl Default for Snapshot

Available on crate feature std only.

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Snapshot

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Snapshot