Struct mail_internals::error::EncodingError

pub struct EncodingError { /* fields omitted */ }

A general error appearing when encoding failed in some way.

This error consists of an EncodingErrorKind and a bit of contextual information including: The place the error happened in (Header { name },Body), a string representing the context when it happens (e.g. the word which could not be encoded), and the mail type.

Methods

impl EncodingError

pub fn kind(&self) -> EncodingErrorKind

Return the error kind.

pub fn mail_type(&self) -> Option<MailType>

Return the mail type used when the error appeared.

pub fn str_context(&self) -> Option<&str>

Returns the str_context associated with the error.

pub fn set_str_context<I>(&mut self, ctx: I) where
    I: Into<String>, 

Sets the str context.

pub fn with_str_context<I>(self, ctx: I) -> Self where
    I: Into<String>, 

Returns a version of self which has a str context like the given one.

pub fn with_place_or_else<F>(self, func: F) -> Self where
    F: FnOnce() -> Option<Place>, 

Adds a place (context) to self if there isn't one and returns self.

pub fn with_mail_type_or_else<F>(self, func: F) -> Self where
    F: FnOnce() -> Option<MailType>, 

Adds a mail type (context) to self if there isn't one and returns self.

Trait Implementations

impl From<EncodingErrorKind> for EncodingError

fn from(ctx: EncodingErrorKind) -> Self

Performs the conversion.

impl From<Context<EncodingErrorKind>> for EncodingError

fn from(inner: Context<EncodingErrorKind>) -> Self

Performs the conversion.

impl From<(EncodingErrorKind, MailType)> for EncodingError

fn from((ctx, mail_type): (EncodingErrorKind, MailType)) -> Self

Performs the conversion.

impl From<(Context<EncodingErrorKind>, MailType)> for EncodingError

fn from((inner, mail_type): (Context<EncodingErrorKind>, MailType)) -> Self

Performs the conversion.

impl Display for EncodingError

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

Formats the value using the given formatter.

impl Debug for EncodingError

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

Formats the value using the given formatter.

impl Fail for EncodingError

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

Returns a reference to the underlying cause of this failure, if it is an error that wraps other errors.

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

Returns a reference to the Backtrace carried by this failure, if it carries one.

fn name(&self) -> Option<&str>

Returns the "name" of the error.

fn context<D>(self, context: D) -> Context<D> where
    D: Display + Send + Sync + 'static, 

Provides context for this failure.

fn compat(self) -> Compat<Self>

Wraps this failure in a compatibility wrapper that implements std::error::Error.