Struct Tunnel

pub struct Tunnel { /* private fields */ }

A tunnel endpoint. This type persists over tunnel reconstructions.

Use OnionContext::build_tunnel to build a new tunnel.

We differentiate persistent and ephemeral tunnels. A persistent tunnel is characterized only by its ID and its endpoints, while an ephemeral tunnel is specific to the intermediate hops. As a user, you will only deal with persistent tunnels, which forward data to and from periodically rebuilt ephemeral tunnels.

Implementations

impl Tunnel

pub async fn read(&mut self) -> Result<Bytes>

Receive data from the remote peer.

Returns an error if the connection was closed.

pub fn write(&self, buf: Bytes) -> Result<()>

Send data to the remote peer.

The data may be split across multiple messages if it is too large to fit into a single one.

Returns an error if the connection was closed.

pub fn id(&self) -> TunnelId

Returns the unique id of this tunnel.

pub fn writer(&self) -> TunnelWriter

Create an additional write handle to this tunnel.

Trait Implementations

impl Debug for Tunnel

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

Formats the value using the given formatter.

impl Drop for Tunnel

fn drop(&mut self)

Executes the destructor for this type.