Struct CircuitId 

pub struct CircuitId(pub String);

A unique identifier for a Tor circuit.

Circuit IDs are assigned by Tor when circuits are created and are used to reference specific circuits in control protocol commands. The ID is a string representation of a numeric identifier.

Invariants

• Circuit IDs are unique within a Tor session
• IDs are assigned sequentially by Tor
• An ID remains valid until the circuit is closed

Example

use stem_rs::controller::CircuitId;

let id = CircuitId::new("42");
assert_eq!(id.to_string(), "42");

// CircuitIds can be compared for equality
let id2 = CircuitId::new("42");
assert_eq!(id, id2);

See Also

• Controller::get_circuits: Retrieve active circuits
• Controller::new_circuit: Create a new circuit
• Controller::close_circuit: Close a circuit by ID

Tuple Fields

0: String

Implementations

impl CircuitId

pub fn new(id: impl Into<String>) -> Self

Creates a new circuit ID from any string-like value.

Arguments

• id - The circuit identifier, typically a numeric string

Example

use stem_rs::controller::CircuitId;

let id = CircuitId::new("123");
let id_from_string = CircuitId::new(String::from("123"));
assert_eq!(id, id_from_string);

Trait Implementations

impl Clone for CircuitId

fn clone(&self) -> CircuitId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CircuitId

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

Formats the value using the given formatter.

impl Display for CircuitId

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

Formats the value using the given formatter.

impl Hash for CircuitId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CircuitId

fn eq(&self, other: &CircuitId) -> 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 Eq for CircuitId

impl StructuralPartialEq for CircuitId