# Struct failure::Context [−] [src]

    pub struct Context<D: Display + Send + Sync + 'static> { /* fields omitted */ }

An error with context around it.

The context is intended to be a human-readable, user-facing explanation for the error that has occurred. The underlying error is not assumed to be end-user-relevant information.

The `Display` impl for `Context` only prints the human-readable context, while the `Debug` impl also prints the underlying error.

## Methods

### `impl<D: Display + Send + Sync + 'static> Context<D>`
[src]

#### `pub fn new(context: D) -> Context<D>`
[src]

Creates a new context without an underlying error message.

####
ⓘImportant traits for &'a mut R

### Important traits for &'a mut R

`impl<'a, R> Read for &'a mut R where
R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;`
`pub fn get_context(&self) -> &D`
[src]

Returns a reference to the context provided with this error.

## Trait Implementations

### `impl<D: Display + Send + Sync + 'static> Fail for Context<D>`
[src]

#### `fn cause(&self) -> Option<&Fail>`
[src]

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

#### `fn backtrace(&self) -> Option<&Backtrace>`
[src]

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

#### `fn context<D>(self, context: D) -> Context<D> where
D: Display + Send + Sync + 'static,
Self: Sized,`
[src]

Provides context for this failure. Read more

#### `fn compat(self) -> Compat<Self> where
Self: Sized,`
[src]

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

####
ⓘImportant traits for Causes<'f>

### Important traits for Causes<'f>

`impl<'f> Iterator for Causes<'f> type Item = &'f Fail;`
`fn causes(&self) -> Causes where
Self: Sized,`
[src]

Returns a iterator over the causes of this `Fail` with itself as the first item and the `root_cause` as the final item. Read more

#### `fn root_cause(&self) -> &Fail where
Self: Sized,`
[src]

Returns the "root cause" of this `Fail` - the last value in the cause chain which does not return an underlying `cause`. Read more

### `impl<D: Display + Send + Sync + 'static> Debug for Context<D>`
[src]

#### `fn fmt(&self, f: &mut Formatter) -> Result`
[src]

Formats the value using the given formatter. Read more

### `impl<D: Display + Send + Sync + 'static> Display for Context<D>`
[src]

#### `fn fmt(&self, f: &mut Formatter) -> Result`
[src]

Formats the value using the given formatter. Read more

### `impl<D> From<D> for Context<D> where
D: Display + Send + Sync + 'static,`
[src]

#### `fn from(display: D) -> Context<D>`
[src]

Performs the conversion.

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)