Enum Error 

#[non_exhaustive]
pub enum Error {
    Network {
        target: SocketAddr,
        source: Error,
    },
    Timeout {
        target: SocketAddr,
        elapsed: Duration,
        retries: u32,
    },
    Closed {
        target: SocketAddr,
    },
    Snmp {
        target: SocketAddr,
        status: ErrorStatus,
        index: u32,
        oid: Option<Oid>,
    },
    Auth {
        target: SocketAddr,
    },
    MalformedResponse {
        target: SocketAddr,
    },
    WalkAborted {
        target: SocketAddr,
        reason: WalkAbortReason,
    },
    Config(Box<str>),
    InvalidOid(Box<str>),
}

The main error type for all async-snmp operations.

This enum covers all possible error conditions including network issues, protocol errors, authentication failures, and configuration problems.

Errors are boxed (via Result) to keep the size small on the stack.

Common Patterns

Checking Error Type

Use pattern matching to handle specific error conditions:

use async_snmp::{Error, ErrorStatus};

fn is_retriable(error: &Error) -> bool {
    matches!(error,
        Error::Timeout { .. } |
        Error::Network { .. }
    )
}

fn is_access_error(error: &Error) -> bool {
    matches!(error,
        Error::Snmp { status: ErrorStatus::NoAccess | ErrorStatus::AuthorizationError, .. } |
        Error::Auth { .. }
    )
}

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.

Network

Network failure (connection refused, unreachable, etc.)

Fields

target: SocketAddr

source: Error

Timeout

Request timed out after retries.

Fields

target: SocketAddr

elapsed: Duration

retries: u32

Closed

Transport was shut down while a request was pending.

Not retriable: the transport will never deliver a response again. Recovery requires creating a new transport.

Fields

target: SocketAddr

Snmp

SNMP protocol error from agent.

Fields

target: SocketAddr

status: ErrorStatus

index: u32

oid: Option<Oid>

Auth

Authentication/authorization failed.

Fields

target: SocketAddr

MalformedResponse

Malformed response from agent.

Fields

target: SocketAddr

WalkAborted

Walk aborted due to agent misbehavior.

Fields

target: SocketAddr

reason: WalkAbortReason

Config(Box<str>)

Invalid configuration.

InvalidOid(Box<str>)

Invalid OID format.

Implementations

impl Error

pub fn boxed(self) -> Box<Self>

Box this error (convenience for constructing boxed errors).

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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

Returns the lower-level source of this error, if any.

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.