Struct ConnectionBandwidthEvent 

pub struct ConnectionBandwidthEvent {
    pub id: String,
    pub conn_type: ConnectionType,
    pub read: u64,
    pub written: u64,
    /* private fields */
}

Event providing bandwidth information for a specific connection.

This event tracks bandwidth usage per connection, categorized by connection type (OR, Dir, Exit). Useful for detailed bandwidth analysis and monitoring.

Connection Types

• ConnectionType::Or - Onion Router connections (relay-to-relay)
• ConnectionType::Dir - Directory connections
• ConnectionType::Exit - Exit connections to the internet

Example

use stem_rs::events::ConnectionBandwidthEvent;
use stem_rs::ConnectionType;

fn handle_conn_bw(event: &ConnectionBandwidthEvent) {
    let type_str = match event.conn_type {
        ConnectionType::Or => "OR",
        ConnectionType::Dir => "Dir",
        ConnectionType::Exit => "Exit",
    };
    println!("{} connection {}: {} read, {} written",
        type_str, event.id, event.read, event.written);
}

See Also

• BandwidthEvent - Aggregate bandwidth
• CircuitBandwidthEvent - Per-circuit bandwidth
• ConnectionType - Connection types

Fields

id: String

Connection identifier.

conn_type: ConnectionType

Type of connection.

read: u64

Bytes read on this connection.

written: u64

Bytes written on this connection.

Implementations

impl ConnectionBandwidthEvent

pub fn parse(content: &str) -> Result<Self, Error>

Parses a connection bandwidth event from raw control protocol content.

Arguments

• content - The event content after the event type

Event Format

ID=ConnID TYPE=ConnType READ=bytes WRITTEN=bytes

Errors

Returns Error::Protocol if:

• Required fields (ID, TYPE, READ, WRITTEN) are missing
• The connection type is unrecognized
• Numeric values cannot be parsed

Trait Implementations

impl Clone for ConnectionBandwidthEvent

fn clone(&self) -> ConnectionBandwidthEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectionBandwidthEvent

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

Formats the value using the given formatter.

impl Event for ConnectionBandwidthEvent

fn event_type(&self) -> EventType

Returns the type of this event.

fn raw_content(&self) -> &str

Returns the raw, unparsed content of the event.

fn arrived_at(&self) -> Instant

Returns the instant when this event was received.