Enum Output 

pub enum Output {
    File(PathBuf),
    Tcp(String),
    Channel(Sender<Snapshot>),
}

Output destination for snapshots.

Configure where the instrumentor should emit snapshots.

Variants

File(PathBuf)

Write snapshots to a JSON file.

The file is overwritten with each snapshot.

Tcp(String)

Send snapshots to a TCP server.

Each snapshot is sent as a newline-delimited JSON message.

Channel(Sender<Snapshot>)

Send snapshots through a channel.

Use Output::channel() to create this variant and get the receiver.

Implementations

impl Output

pub fn file(path: impl Into<PathBuf>) -> Self

Create a file output.

Example

use buswatch_sdk::Output;

let output = Output::file("metrics.json");

pub fn tcp(addr: impl Into<String>) -> Self

Create a TCP output.

Example

use buswatch_sdk::Output;

let output = Output::tcp("localhost:9090");

pub fn channel(buffer: usize) -> (Self, Receiver<Snapshot>)

Create a channel output and return both the output and receiver.

This is useful for integrating with your own snapshot handling.

Example

use buswatch_sdk::Output;

let (output, mut rx) = Output::channel(16);

// Later, receive snapshots
// while let Some(snapshot) = rx.recv().await {
//     println!("Got snapshot with {} modules", snapshot.len());
// }

Trait Implementations

impl Debug for Output

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

Formats the value using the given formatter.