Enum NetStackError 

#[non_exhaustive]
pub enum NetStackError {
    #[non_exhaustive]
    PrefixInvalid {
        network: IpAddr,
        prefix_len: u8,
        reason: &'static str,
    },
    #[non_exhaustive]
    MtuInvalid {
        mtu: u16,
        minimum: u16,
    },
    #[non_exhaustive]
    InterfaceNameInvalid {
        name: String,
    },
    NoProtocols,
    SharedNamespace,
    #[non_exhaustive]
    NamespaceJoin {
        which: &'static str,
        source: Option<Error>,
    },
    #[non_exhaustive]
    TapOpen {
        source: Error,
    },
    #[non_exhaustive]
    TapCreate {
        name: String,
        source: Error,
    },
    #[non_exhaustive]
    TapConfigure {
        detail: &'static str,
        source: Error,
    },
    #[non_exhaustive]
    TapHandoff {
        source: Error,
    },
    #[non_exhaustive]
    Spawn {
        source: Error,
    },
    HelperLost,
    #[non_exhaustive]
    Pump {
        op: &'static str,
        source: Option<Error>,
    },
}

An error from building or running a network stack.

Never a crate::Error: the stack is an attachment to a sandbox, not part of launching one, and its failures are its own. A failed attach leaves the pending launch untouched — the caller may still proceed (without connectivity) or drop it.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

#[non_exhaustive]

PrefixInvalid

A configured network cannot hold the stack’s address plan.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

network: IpAddr

The network address as it was given to the builder.

prefix_len: u8

The prefix length as it was given to the builder.

reason: &'static str

What makes the pair unusable.

#[non_exhaustive]

MtuInvalid

The MTU is below the minimum for the enabled protocols.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

mtu: u16

The MTU as it was given to the builder.

minimum: u16

The minimum the enabled protocols require.

#[non_exhaustive]

InterfaceNameInvalid

The interface name does not satisfy the kernel’s rules.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

name: String

The name as it was given to the builder.

NoProtocols

The configuration enables neither IPv4 nor IPv6.

SharedNamespace

The sandbox shares the caller’s network namespace, where a stack must not attach. Sandboxes built with Network::Host are refused with this error.

#[non_exhaustive]

NamespaceJoin

The sandbox’s network namespace could not be examined or joined.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

which: &'static str

The step that failed.

source: Option<Error>

The underlying error, absent where the failure carried none.

#[non_exhaustive]

TapOpen

/dev/net/tun could not be opened.

The tun device is compiled into every mainstream kernel but a host may omit the module or restrict the device node; the stack cannot run there.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

source: Error

The underlying error.

#[non_exhaustive]

TapCreate

The tap interface could not be created.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

name: String

The interface name the creation was asked for.

source: Error

The underlying error.

#[non_exhaustive]

TapConfigure

The tap interface was created but could not be configured.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

detail: &'static str

The configuration step that failed.

source: Error

The underlying error.

#[non_exhaustive]

TapHandoff

The tap was created and configured, but its descriptor could not be handed back to the caller.

Distinct from TapConfigure: nothing is wrong with the interface, only with the handoff, and the tap is destroyed with the helper that made it.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

source: Error

The underlying error.

#[non_exhaustive]

Spawn

The stack’s helper process or pump thread could not be started.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

source: Error

The underlying error.

HelperLost

The tap helper exited without delivering a result.

The helper always reports an outcome — the tap descriptor or a typed failure — before it exits; silence means it was killed from outside or its result could not be read.

#[non_exhaustive]

Pump

The pump stopped on an error of its own machinery, reported by NetStackHandle::stop.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

op: &'static str

The operation the pump failed at.

source: Option<Error>

The underlying error, absent where the pump stopped on something that was not a syscall failure.

Trait Implementations

impl Debug for NetStackError

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

Formats the value using the given formatter.

impl Display for NetStackError

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

Formats the value using the given formatter.

impl Error for NetStackError

fn source(&self) -> Option<&(dyn Error + 'static)>

The OS failure underneath, where there is one.

The configuration refusals — an unusable prefix, an MTU below the minimum, an invalid interface name, no protocols, a shared namespace — carry no inner error: nothing failed, the request was refused. HelperLost carries none either: the helper’s silence is the failure.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.