std::error::Error - Rust
Description: API documentation for the Rust `Error` trait in crate `std`.
Keywords: rust, rustlang, rust-lang, Error

# Trait std::error::Error 1.0.0 [−] [src]

    pub trait Error: Debug + Display {
        fn description(&self) -> &str;

        fn cause(&self) -> Option<&Error> { ... }
    }

Base functionality for all errors in Rust.

## Required Methods

### `fn description(&self) -> &str`

A short description of the error.

The description should only be used for a simple message. It should not contain newlines or sentence-ending punctuation, to facilitate embedding in larger user-facing strings. For showing formatted error messages with more information see `Display`.

# Examples

    use std::error::Error;

    match "xc".parse::<u32>() {
        Err(e) => {
            println!("Error: {}", e.description());
        }
        _ => println!("No error"),
    }Run

## Provided Methods

### `fn cause(&self) -> Option<&Error>`

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

# Examples

    use std::error::Error;
    use std::fmt;

    #[derive(Debug)]
    struct SuperError {
        side: SuperErrorSideKick,
    }

    impl fmt::Display for SuperError {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            write!(f, "SuperError is here!")
        }
    }

    impl Error for SuperError {
        fn description(&self) -> &str {
            "I'm the superhero of errors"
        }

        fn cause(&self) -> Option<&Error> {
            Some(&self.side)
        }
    }

    #[derive(Debug)]
    struct SuperErrorSideKick;

    impl fmt::Display for SuperErrorSideKick {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            write!(f, "SuperErrorSideKick is here!")
        }
    }

    impl Error for SuperErrorSideKick {
        fn description(&self) -> &str {
            "I'm SuperError side kick"
        }
    }

    fn get_super_error() -> Result<(), SuperError> {
        Err(SuperError { side: SuperErrorSideKick })
    }

    fn main() {
        match get_super_error() {
            Err(e) => {
                println!("Error: {}", e.description());
                println!("Caused by: {}", e.cause().unwrap());
            }
            _ => println!("No error"),
        }
    }Run

## Methods

### `impl Error + 'static`
[src]

#### `pub fn is<T: Error + 'static>(&self) -> bool`
1.3.0
[src]

Returns true if the boxed type is the same as `T`

#### `pub fn downcast_ref<T: Error + 'static>(&self) -> Option<&T>`
1.3.0
[src]

Returns some reference to the boxed value if it is of type `T`, or `None` if it isn't.

#### `pub fn downcast_mut<T: Error + 'static>(&mut self) -> Option<&mut T>`
1.3.0
[src]

Returns some mutable reference to the boxed value if it is of type `T`, or `None` if it isn't.

### `impl Error + Send + 'static`
[src]

#### `pub fn is<T: Error + 'static>(&self) -> bool`
1.3.0
[src]

Forwards to the method defined on the type `Any`.

#### `pub fn downcast_ref<T: Error + 'static>(&self) -> Option<&T>`
1.3.0
[src]

Forwards to the method defined on the type `Any`.

#### `pub fn downcast_mut<T: Error + 'static>(&mut self) -> Option<&mut T>`
1.3.0
[src]

Forwards to the method defined on the type `Any`.

### `impl Error + Send + Sync + 'static`
[src]

#### `pub fn is<T: Error + 'static>(&self) -> bool`
1.3.0
[src]

Forwards to the method defined on the type `Any`.

#### `pub fn downcast_ref<T: Error + 'static>(&self) -> Option<&T>`
1.3.0
[src]

Forwards to the method defined on the type `Any`.

#### `pub fn downcast_mut<T: Error + 'static>(&mut self) -> Option<&mut T>`
1.3.0
[src]

Forwards to the method defined on the type `Any`.

### `impl Error`
[src]

#### `pub fn downcast<T: Error + 'static>(
self: Box<Self>
) -> Result<Box<T>, Box<Error>>`
1.3.0
[src]

Attempt to downcast the box to a concrete type.

### `impl Error + Send`
[src]

#### `pub fn downcast<T: Error + 'static>(
self: Box<Self>
) -> Result<Box<T>, Box<Error + Send>>`
1.3.0
[src]

Attempt to downcast the box to a concrete type.

### `impl Error + Send + Sync`
[src]

#### `pub fn downcast<T: Error + 'static>(
self: Box<Self>
) -> Result<Box<T>, Box<Self>>`
1.3.0
[src]

Attempt to downcast the box to a concrete type.

## Implementations on Foreign Types

### `impl Error for TryFromSliceError`
[src]

#### `fn description(&self) -> &str`
[src]

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

## Implementors

- [src]
  `impl Error for VarError`
- [src]
  `impl Error for JoinPathsError`
- [src]
  `impl Error for !`
- [src]
  `impl Error for AllocErr`
- [src]
  `impl Error for CannotReallocInPlace`
- [src]
  `impl Error for ParseBoolError`
- [src]
  `impl Error for Utf8Error`
- [src]
  `impl Error for ParseIntError`
- [src]
  `impl Error for TryFromIntError`
- [src]
  `impl Error for ParseFloatError`
- [src]
  `impl Error for FromUtf8Error`
- [src]
  `impl Error for FromUtf16Error`
- [src]
  `impl Error for ParseError`
- [src]
  `impl Error for DecodeUtf16Error`
- [src]
  `impl<T: Error> Error for Box<T>`
- [src]
  `impl Error for std::fmt::Error`
- [src]
  `impl Error for BorrowError`
- [src]
  `impl Error for BorrowMutError`
- [src]
  `impl Error for CharTryFromError`
- [src]
  `impl Error for ParseCharError`
- [src]
  `impl Error for Infallible`
- [src]
  `impl Error for NulError`
- [src]
  `impl Error for FromBytesWithNulError`
- [src]
  `impl Error for IntoStringError`
- [src]
  `impl<W: Send + Debug> Error for IntoInnerError<W>`
- [src]
  `impl Error for std::io::Error`
- [src]
  `impl Error for CharsError`
- [src]
  `impl Error for AddrParseError`
- [src]
  `impl Error for StripPrefixError`
- [src]
  `impl<T: Send> Error for SendError<T>`
- [src]
  `impl<T: Send> Error for TrySendError<T>`
- [src]
  `impl Error for RecvError`
- [src]
  `impl Error for TryRecvError`
- [src]
  `impl Error for RecvTimeoutError`
- [src]
  `impl Error for SystemTimeError`
- [src]
  `impl<T> Error for PoisonError<T>`
- [src]
  `impl<T> Error for TryLockError<T>`

# 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
+ / -
  Collapse/expand 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`)