Skip to main content

HandlerError

Struct HandlerError 

Source
pub struct HandlerError { /* private fields */ }
Expand description

A handler processing failure, reported to the manager as a genErr Response.

Returned as the Err side of HandlerResult from MibHandler::get and MibHandler::get_next when the handler failed to process the request — the backing store was unreachable, a lock was poisoned, a hardware read timed out. It is distinct from the RFC 3416 exception values, which are successful answers about the MIB:

SituationReturn
Object/instance doesn’t existOk(GetResult::NoSuchObject / NoSuchInstance)
No more OIDs in the subtreeOk(GetNextResult::EndOfMibView)
Couldn’t find out (backend failure)Err(HandlerError)

When a handler returns an error, the agent answers the whole request with error-status genErr and error-index set to the failing variable binding (RFC 3416 Section 4.2.1), for all protocol versions. The message and source are logged by the agent; they are never sent on the wire — genErr carries no detail.

§Construction

Any std::error::Error converts via ?, or build one from a message:

use async_snmp::handler::{HandlerError, HandlerResult, GetResult};

fn read_backend() -> std::io::Result<i32> {
    Err(std::io::Error::other("device bus timeout"))
}

fn get_value() -> HandlerResult<GetResult> {
    let raw = read_backend()?; // io::Error -> HandlerError
    Ok(GetResult::Value(async_snmp::Value::Integer(raw)))
}

let err: HandlerError = HandlerError::new("cache poisoned");
assert_eq!(err.message(), "cache poisoned");
assert!(get_value().is_err());

HandlerError intentionally does not implement std::error::Error: that keeps the blanket From<E: std::error::Error> conversion (and with it ? on arbitrary error types) possible, the same trade-off anyhow::Error makes. It is a terminal type — the agent consumes it; nothing converts out of it.

Implementations§

Source§

impl HandlerError

Source

pub fn new(message: impl Into<Cow<'static, str>>) -> Self

Create an error from a message describing what failed.

Source

pub fn message(&self) -> &str

The failure message (used for agent-side logging only; never sent on the wire).

Source

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

The underlying error this was converted from, if any.

Trait Implementations§

Source§

impl Debug for HandlerError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for HandlerError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<E: Error + Send + Sync + 'static> From<E> for HandlerError

Source§

fn from(err: E) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<!> for T

Source§

fn from(t: !) -> T

Converts to this type from the input type.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more