Struct StreamEvent 

pub struct StreamEvent {
    pub id: StreamId,
    pub status: StreamStatus,
    pub circuit_id: Option<CircuitId>,
    pub target_host: String,
    pub target_port: u16,
    pub reason: Option<StreamClosureReason>,
    pub remote_reason: Option<StreamClosureReason>,
    pub source: Option<StreamSource>,
    pub source_addr: Option<String>,
    pub purpose: Option<StreamPurpose>,
    /* private fields */
}

Event indicating that a stream’s status has changed.

Stream events track the lifecycle of TCP connections made through Tor. Each stream is associated with a circuit and connects to a specific target host and port.

Stream Lifecycle

Streams progress through these states:

1. StreamStatus::New - New stream request received
2. StreamStatus::SentConnect - CONNECT sent to exit relay
3. StreamStatus::Remap - Address remapped (e.g., DNS resolution)
4. StreamStatus::Succeeded - Connection established
5. StreamStatus::Closed or StreamStatus::Failed - Stream terminated

Circuit Association

The circuit_id field indicates which circuit carries this stream. A value of None (circuit ID “0”) means the stream is not yet attached to a circuit.

Example

use stem_rs::events::StreamEvent;
use stem_rs::StreamStatus;

fn handle_stream(event: &StreamEvent) {
    match event.status {
        StreamStatus::New => {
            println!("New stream {} to {}:{}",
                event.id, event.target_host, event.target_port);
        }
        StreamStatus::Succeeded => {
            println!("Stream {} connected via circuit {:?}",
                event.id, event.circuit_id);
        }
        StreamStatus::Closed | StreamStatus::Failed => {
            println!("Stream {} ended: {:?}", event.id, event.reason);
        }
        _ => {}
    }
}

See Also

• StreamStatus - Stream status values
• StreamPurpose - Stream purpose types
• StreamClosureReason - Closure reasons

Fields

id: StreamId

Unique identifier for this stream.

status: StreamStatus

Current status of the stream.

circuit_id: Option<CircuitId>

Circuit carrying this stream, or None if unattached.

target_host: String

Target hostname or IP address.

target_port: u16

Target port number.

reason: Option<StreamClosureReason>

Reason for stream closure (local).

remote_reason: Option<StreamClosureReason>

Reason for stream closure (from remote side).

source: Option<StreamSource>

Source of address resolution (cache or exit).

source_addr: Option<String>

Source address of the client connection.

purpose: Option<StreamPurpose>

Purpose of this stream.

Implementations

impl StreamEvent

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

Parses a stream event from raw control protocol content.

Arguments

• content - The event content after the event type

Event Format

StreamID StreamStatus CircuitID Target [REASON=...] [REMOTE_REASON=...]
[SOURCE=...] [SOURCE_ADDR=...] [PURPOSE=...]

Errors

Returns Error::Protocol if:

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

Trait Implementations

impl Clone for StreamEvent

fn clone(&self) -> StreamEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamEvent

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

Formats the value using the given formatter.

impl Event for StreamEvent

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.