Struct Stream 

pub struct Stream {
    pub id: StreamId,
    pub status: StreamStatus,
    pub circuit_id: Option<CircuitId>,
    pub target_host: String,
    pub target_port: u16,
}

Information about an active Tor stream.

A stream represents a single TCP connection being routed through a Tor circuit. Streams are created when applications connect through Tor’s SOCKS proxy and are attached to circuits for routing.

Stream Lifecycle

Streams progress through several states:

1. New: Stream created, awaiting circuit attachment
2. SentConnect: CONNECT command sent to exit relay
3. Succeeded: Connection established successfully
4. Failed: Connection attempt failed
5. Closed: Stream has been closed

Fields

• id: Unique identifier for this stream
• status: Current state of the stream
• circuit_id: The circuit this stream is attached to (if any)
• target_host: Destination hostname or IP address
• target_port: Destination port number

Example

use stem_rs::controller::Controller;
use stem_rs::StreamStatus;

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

for stream in controller.get_streams().await? {
    println!("Stream {} -> {}:{} ({:?})",
        stream.id,
        stream.target_host,
        stream.target_port,
        stream.status
    );
    if let Some(ref circuit_id) = stream.circuit_id {
        println!("  Attached to circuit {}", circuit_id);
    }
}

See Also

• Controller::get_streams: Retrieve all active streams
• Controller::attach_stream: Attach a stream to a circuit
• StreamStatus: Stream status enumeration

Fields

id: StreamId

Unique identifier for this stream.

status: StreamStatus

Current status of the stream.

See StreamStatus for possible values.

circuit_id: Option<CircuitId>

The circuit this stream is attached to, if any.

Streams in the New or Detached state may not be attached to any circuit. Once attached, this field contains the circuit ID.

target_host: String

Destination hostname or IP address.

This is the target the stream is connecting to through Tor.

target_port: u16

Destination port number.

The TCP port on the target host. May be 0 if not specified.

Trait Implementations

impl Clone for Stream

fn clone(&self) -> Stream

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Stream

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

Formats the value using the given formatter.