Struct mail_headers::error::ComponentCreationError

pub struct ComponentCreationError { /* fields omitted */ }

Creating a (header field) component from the given data failed

A good example converting a string to a mailbox by parsing it, or more concretely failing to do so because it's not a valid mail address.

Methods

impl ComponentCreationError

pub fn from_parent<P>(parent: P, component: &'static str) -> Self where
    P: Into<FError>, 

create a new ComponentCreationError based on a different error and the name of the component

The name is normally the type name, for example Email, Mailbox etc.

pub fn new(component: &'static str) -> Self

creates a new ComponentCreationError based on the components name

The name is normally the type name, for example Email, Mailbox etc.

pub fn new_with_str<I>(component: &'static str, str_context: I) -> Self where
    I: Into<String>, 

creates a new ComponentCreationError based on the components name with a str_context

The name is normally the type name, for example Email, Mailbox etc.

The str_context is a snipped of text which can help a human to identify the invalid parts, e.g. for parsing a email it could be the invalid email address.

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

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

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

Trait Implementations

impl Debug for ComponentCreationError

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

Formats the value using the given formatter.

impl Display for ComponentCreationError

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

Formats the value using the given formatter.

impl Fail for ComponentCreationError

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.