Struct StreamId 

pub struct StreamId(pub String);

A unique identifier for a Tor stream.

Stream IDs are assigned by Tor when streams are created and are used to reference specific streams in control protocol commands. Streams represent individual TCP connections being routed through Tor circuits.

Invariants

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

Example

use stem_rs::controller::StreamId;

let id = StreamId::new("99");
assert_eq!(id.to_string(), "99");

// StreamIds can be compared for equality
let id2 = StreamId::new("99");
assert_eq!(id, id2);

See Also

• Controller::get_streams: Retrieve active streams
• Controller::attach_stream: Attach a stream to a circuit
• Controller::close_stream: Close a stream by ID

Tuple Fields

0: String

Implementations

impl StreamId

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

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

Arguments

• id - The stream identifier, typically a numeric string

Example

use stem_rs::controller::StreamId;

let id = StreamId::new("456");
let id_from_string = StreamId::new(String::from("456"));
assert_eq!(id, id_from_string);

Trait Implementations

impl Clone for StreamId

fn clone(&self) -> StreamId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamId

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

Formats the value using the given formatter.

impl Display for StreamId

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

Formats the value using the given formatter.

impl Hash for StreamId

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 StreamId

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

impl StructuralPartialEq for StreamId