Struct tor_proto::channel::Channel

pub struct Channel { /* fields omitted */ }

An open client channel, ready to send and receive Tor cells.

A channel is a direct connection to a Tor relay, implemented using TLS.

Implementations

impl Channel

pub fn unique_id(&self) -> UniqId

Return a process-unique identifier for this channel.

pub fn peer_ed25519_id(&self) -> &Ed25519Identity

Return the Ed25519 identity for the peer of this channel.

pub fn peer_rsa_id(&self) -> &RsaIdentity

Return the (legacy) RSA identity for the peer of this channel.

pub fn check_match<T: ChanTarget + ?Sized>(&self, target: &T) -> Result<()>

Return an error if this channel is somehow mismatched with the given target.

pub fn is_closing(&self) -> bool

Return true if this channel is closed and therefore unusable.

pub async fn send_cell(&self, cell: ChanCell) -> Result<()>

Transmit a single cell on a channel.

pub async fn new_circ<R: Rng>(
    self: &Arc<Self>,
    rng: &mut R
) -> Result<(PendingClientCirc, Reactor)>

Return a newly allocated PendingClientCirc object with a corresponding circuit reactor. A circuit ID is allocated, but no messages are sent, and no cryptography is done.

To use the results of this method, call Reactor::run() in a new task, then use the methods of crate::circuit::PendingClientCirc to build the circuit.

pub async fn terminate(&self)

Shut down this channel immediately, along with all circuits that are using it.

Note that other references to this channel may exist. If they do, they will stop working after you call this function.

It’s not necessary to call this method if you’re just done with a channel: the channel should close on its own once nothing is using it any more.

Trait Implementations

impl Debug for Channel

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

Formats the value using the given formatter.