Struct Circuit 

pub struct Circuit {
    pub id: CircuitId,
    pub status: CircStatus,
    pub path: Vec<RelayInfo>,
}

Information about an active Tor circuit.

A circuit is a path through the Tor network consisting of multiple relay hops. Circuits are used to route traffic anonymously by encrypting data in layers that are peeled off at each hop.

Circuit Lifecycle

Circuits progress through several states:

1. Launched: Circuit creation has begun
2. Extended: Circuit is being extended to additional hops
3. Built: Circuit is fully constructed and ready for use
4. Failed: Circuit construction failed
5. Closed: Circuit has been closed

Fields

• id: Unique identifier for this circuit
• status: Current state of the circuit
• path: Ordered list of relays in the circuit (guard → middle → exit)

Example

use stem_rs::controller::Controller;
use stem_rs::CircStatus;

let mut controller = Controller::from_port("127.0.0.1:9051".parse()?).await?;
controller.authenticate(None).await?;

for circuit in controller.get_circuits().await? {
    if circuit.status == CircStatus::Built {
        println!("Circuit {} has {} hops:", circuit.id, circuit.path.len());
        for (i, relay) in circuit.path.iter().enumerate() {
            println!("  Hop {}: {} ({:?})", i + 1, relay.fingerprint, relay.nickname);
        }
    }
}

See Also

• Controller::get_circuits: Retrieve all active circuits
• Controller::new_circuit: Create a new circuit
• CircStatus: Circuit status enumeration

Fields

id: CircuitId

Unique identifier for this circuit.

status: CircStatus

Current status of the circuit.

See CircStatus for possible values.

path: Vec<RelayInfo>

Ordered list of relays in the circuit path.

The first relay is the guard (entry) node, and the last relay is typically the exit node. The path may be empty for newly launched circuits that haven’t yet established any hops.

Trait Implementations

impl Clone for Circuit

fn clone(&self) -> Circuit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Circuit

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

Formats the value using the given formatter.