     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42

    use core::fmt::{self, Display};

    /// A compatibility wrapper around an error type from this crate.
    ///
    /// `Compat` implements `std::error::Error`, allowing the types from this
    /// crate to be passed to interfaces that expect a type of that trait.
    #[derive(Debug, Copy, Clone, Eq, PartialEq, Hash, Default)]
    pub struct Compat<E> {
        pub(crate) error: E,
    }

    impl<E: Display> Display for Compat<E> {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            Display::fmt(&self.error, f)
        }
    }

    impl<E> Compat<E> {
        /// Unwraps this into the inner error.
        pub fn into_inner(self) -> E {
            self.error
        }
    }

    with_std! {
        use std::fmt::Debug;
        use std::error::Error as StdError;

        use Error;

        impl<E: Display + Debug> StdError for Compat<E> {
            fn description(&self) -> &'static str {
                "An error has occurred."
            }
        }

        impl From<Error> for Box<StdError> {
            fn from(error: Error) -> Box<StdError> {
                Box::new(Compat { error })
            }
        }
    }

# 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`)