Struct OrConnEvent 

pub struct OrConnEvent {
    pub id: Option<String>,
    pub status: OrStatus,
    pub target: String,
    pub reason: Option<OrClosureReason>,
    pub num_circuits: Option<u32>,
    /* private fields */
}

Event indicating that an OR (Onion Router) connection status has changed.

OR connection events track the status of connections between Tor relays. These are the TLS connections that carry circuit traffic between nodes in the Tor network.

Connection Lifecycle

OR connections progress through these states:

1. OrStatus::New - Connection initiated
2. OrStatus::Launched - Connection attempt in progress
3. OrStatus::Connected - TLS handshake completed
4. OrStatus::Failed or OrStatus::Closed - Connection terminated

Example

use stem_rs::events::OrConnEvent;
use stem_rs::OrStatus;

fn handle_orconn(event: &OrConnEvent) {
    match event.status {
        OrStatus::Connected => {
            println!("Connected to relay: {}", event.target);
        }
        OrStatus::Failed | OrStatus::Closed => {
            println!("Connection to {} ended: {:?}", event.target, event.reason);
        }
        _ => {}
    }
}

See Also

• OrStatus - OR connection status values
• OrClosureReason - Closure reasons

Fields

id: Option<String>

Connection identifier (may be None for older Tor versions).

status: OrStatus

Current status of the OR connection.

target: String

Target relay address (IP:port or fingerprint).

reason: Option<OrClosureReason>

Reason for connection closure.

num_circuits: Option<u32>

Number of circuits using this connection.

Implementations

impl OrConnEvent

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

Parses an OR connection event from raw control protocol content.

Arguments

• content - The event content after the event type

Event Format

Target Status [REASON=...] [NCIRCS=...] [ID=...]

Errors

Returns Error::Protocol if:

• Required fields are missing
• The status is not a recognized value

Trait Implementations

impl Clone for OrConnEvent

fn clone(&self) -> OrConnEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OrConnEvent

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

Formats the value using the given formatter.

impl Event for OrConnEvent

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.