Enum TunnelEnd 

pub enum TunnelEnd {
    Closed,
    Refused {
        code: u16,
        reason: String,
    },
    Truncated {
        code: Option<u16>,
    },
    ClosedUnproven,
}

What ended a tunnel, and whether the caller should treat it as a failure.

Exhaustive on purpose: a caller that matched a new way to end under a wildcard arm would report a stream cut short however that arm reports, which is the failure #342 fixed.

Variants

Closed

The local client closed, or the guest reached EOF. The tunnel did its job.

On a verified tunnel whose daemon offered the end of stream, the guest’s EOF is read from the daemon’s end of stream, so every byte the guest sent arrived.

Refused

The daemon refused or lost the guest connection, with its close code.

Carries the code rather than a pre-rendered string so a caller can branch — a dead server is worth retrying against a different port, a relay failure is not.

Fields

code: u16

reason: String

Truncated

A verified tunnel’s daemon offered the end of stream, and the tunnel ended without it: a close frame with no failure code, a transport error, or a hangup (BIND-23).

A failure. Every byte that arrived authenticated, but the stream may have been cut short on the path, or the guest may have stopped reading before all of the local bytes reached it. code is the close frame’s, and None when there was no frame.

Fields

code: Option<u16>

ClosedUnproven

A verified tunnel ended the way TunnelEnd::Closed does, but its daemon predates the end of stream (its handshake didn’t offer one), so nothing proved the stream finished.

Not a failure: an older daemon never sends an end of stream, and failing here would fail every verified tunnel into an older image. A stream cut short would read the same, though, so a caller should say so.

Trait Implementations

impl Clone for TunnelEnd

fn clone(&self) -> TunnelEnd

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TunnelEnd

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

Formats the value using the given formatter.

impl Eq for TunnelEnd

impl PartialEq for TunnelEnd

fn eq(&self, other: &TunnelEnd) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for TunnelEnd