Enum milter::Error

pub enum Error {
    SocketConfig(CString),
    TimeoutConfig(i32),
    SocketBacklogConfig(i32),
    Registration,
    Main,
    CallbackPanic,
    FailureStatus,
    FfiCString(NulError),
    FfiInt(TryFromIntError),
    FfiUtf8(Utf8Error),
    DataAccess(BorrowError),
    DataAccessMut(BorrowMutError),
    Custom(Box<dyn Error + Send + Sync>),
}

Various kinds of errors that can occur in a milter application.

Variants

SocketConfig(CString)

The socket specification provided to the Milter could not be used.

TimeoutConfig(i32)

The timeout duration configuration parameter of the Milter is invalid.

SocketBacklogConfig(i32)

The socket backlog length configuration parameter of the Milter is invalid.

Registration

Registration of the milter’s configuration with the milter library failed.

Main

The milter library’s event loop (main function) exited with a failure status.

CallbackPanic

The milter library’s event loop was shut down after a panic in a callback.

FailureStatus

A milter library function returned the failure status code.

FfiCString(NulError)

Conversion to a C-style string at the FFI boundary (Rust/C) failed, with cause attached.

FfiInt(TryFromIntError)

Conversion to an integer type at the FFI boundary (Rust/C) failed, with cause attached.

FfiUtf8(Utf8Error)

Conversion to a UTF-8 string at the FFI boundary (Rust/C) failed, with cause attached.

DataAccess(BorrowError)

Erroneous immutable access of context data (violation of dynamic borrowing rules), with cause attached.

DataAccessMut(BorrowMutError)

Erroneous mutable access of context data (violation of dynamic borrowing rules), with cause attached.

Custom(Box<dyn Error + Send + Sync>)

An unspecific error variant, with cause attached.

Examples

This variant is provided as a convenience; use it to propagate arbitrary errors out of a callback.

use milter::{Context, Error, Status};
use std::fs::File;

fn handle_data(context: Context<()>) -> milter::Result<Status> {
    let _ = File::create("/tmp/archive").map_err(|e| Error::Custom(e.into()))?;

    Ok(Status::Continue)
}

Trait Implementations

impl From<NulError> for Error

fn from(error: NulError) -> Self

Performs the conversion.

impl From<TryFromIntError> for Error

fn from(error: TryFromIntError) -> Self

Performs the conversion.

impl From<Utf8Error> for Error

fn from(error: Utf8Error) -> Self

Performs the conversion.

impl From<BorrowError> for Error

fn from(error: BorrowError) -> Self

Performs the conversion.

impl From<BorrowMutError> for Error

fn from(error: BorrowMutError) -> Self

Performs the conversion.

impl From<Box<dyn Error + 'static + Sync + Send>> for Error

fn from(error: Box<dyn Error + Send + Sync + 'static>) -> Self

Performs the conversion.

impl Display for Error

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

Formats the value using the given formatter.

impl Debug for Error

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

Formats the value using the given formatter.

impl Error for Error

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

The lower-level source of this error, if any.

fn description(&self) -> &str

This method is soft-deprecated.

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

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

The lower-level cause of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error ocurred.