      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
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191

    //! Standard error type for ocl.
    //!

    use std::fmt;
    use failure::{Context, Fail, Backtrace};
    use util::UtilError;
    use functions::{ApiError, VersionLowError, ProgramBuildError, ApiWrapperError};
    use ::{Status, EmptyInfoResultError};

    /// Ocl error result type.
    pub type Result<T> = ::std::result::Result<T, Error>;

    /// An enum one of several error types.
    #[derive(Debug, Fail)]
    pub enum ErrorKind {
        // String: An arbitrary error:
        //
        // TODO: Remove this eventually. We need to replace every usage
        // (conversion from String/str) with a dedicated error type/variant for
        // each. In the meanwhile, refrain from creating new instances of this by
        // converting strings to `Error`!
        #[fail(display = "{}", _0)]
        String(String),
        // FfiNul: Ffi string conversion error:
        #[fail(display = "{}", _0)]
        FfiNul(#[cause] ::std::ffi::NulError),
        // Io: std::io error:
        #[fail(display = "{}", _0)]
        Io(#[cause] ::std::io::Error),
        // FromUtf8: String conversion error:
        #[fail(display = "{}", _0)]
        FromUtf8(#[cause] ::std::string::FromUtf8Error),
        // IntoString: Ffi string conversion error:
        #[fail(display = "{}", _0)]
        IntoString(#[cause] ::std::ffi::IntoStringError),
        // EmptyInfoResult:
        #[fail(display = "{}", _0)]
        EmptyInfoResult(EmptyInfoResultError),
        // Util:
        #[fail(display = "{}", _0)]
        Util(UtilError),
        // Api:
        #[fail(display = "{}", _0)]
        Api(ApiError),
        // VersionLow:
        #[fail(display = "{}", _0)]
        VersionLow(VersionLowError),
        // ProgramBuild:
        #[fail(display = "{}", _0)]
        ProgramBuild(ProgramBuildError),
        // ApiWrapper:
        #[fail(display = "{}", _0)]
        ApiWrapper(ApiWrapperError),
    }

    /// An Error.
    pub struct Error {
        inner: Context<ErrorKind>,
    }

    impl Error {
        /// Returns the error status code for `Status` variants.
        pub fn api_status(&self) -> Option<Status> {
            match *self.kind() {
                ErrorKind::Api(ref err) => Some(err.status()),
                _ => None,
            }
        }

        /// Returns the error variant and contents.
        pub fn kind(&self) -> &ErrorKind {
            self.inner.get_context()
        }

        /// Returns the immediate cause of this error (e.g. the next error in the
        /// chain).
        pub fn cause(&self) -> Option<&Fail> {
            self.inner.cause()
        }
    }

    impl fmt::Debug for Error {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            fmt::Display::fmt(&self.inner, f)
        }
    }

    impl fmt::Display for Error {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            fmt::Display::fmt(&self.inner, f)
        }
    }

    impl Fail for Error {
        fn cause(&self) -> Option<&Fail> {
            self.inner.cause()
        }

        fn backtrace(&self) -> Option<&Backtrace> {
            self.inner.backtrace()
        }
    }

    impl From<ErrorKind> for Error {
        fn from(kind: ErrorKind) -> Error {
            Error { inner: Context::new(kind) }
        }
    }

    impl From<Context<ErrorKind>> for Error {
        fn from(inner: Context<ErrorKind>) -> Error {
            Error { inner: inner }
        }
    }

    impl From<EmptyInfoResultError> for Error {
        fn from(err: EmptyInfoResultError) -> Self {
            Error { inner: Context::new(ErrorKind::EmptyInfoResult(err)) }
        }
    }

    // TODO: Remove eventually
    impl<'a> From<&'a str> for Error {
        fn from(desc: &'a str) -> Self {
            Error { inner: Context::new(ErrorKind::String(String::from(desc))) }
        }
    }

    // TODO: Remove eventually
    impl From<String> for Error {
        fn from(desc: String) -> Self {
            Error { inner: Context::new(ErrorKind::String(desc)) }
        }
    }

    impl From<::std::ffi::NulError> for Error {
        fn from(err: ::std::ffi::NulError) -> Self {
            Error { inner: Context::new(ErrorKind::FfiNul(err)) }
        }
    }

    impl From<::std::io::Error> for Error {
        fn from(err: ::std::io::Error) -> Self {
            Error { inner: Context::new(ErrorKind::Io(err)) }
        }
    }

    impl From<::std::string::FromUtf8Error> for Error {
        fn from(err: ::std::string::FromUtf8Error) -> Self {
            Error { inner: Context::new(ErrorKind::FromUtf8(err)) }
        }
    }

    impl From<::std::ffi::IntoStringError> for Error {
        fn from(err: ::std::ffi::IntoStringError) -> Self {
            Error { inner: Context::new(ErrorKind::IntoString(err)) }
        }
    }

    impl From<UtilError> for Error {
        fn from(err: UtilError) -> Self {
            Error { inner: Context::new(ErrorKind::Util(err)) }
        }
    }

    impl From<ApiError> for Error {
        fn from(err: ApiError) -> Self {
            Error { inner: Context::new(ErrorKind::Api(err)) }
        }
    }

    impl From<VersionLowError> for Error {
        fn from(err: VersionLowError) -> Self {
            Error { inner: Context::new(ErrorKind::VersionLow(err)) }
        }
    }

    impl From<ProgramBuildError> for Error {
        fn from(err: ProgramBuildError) -> Self {
            Error { inner: Context::new(ErrorKind::ProgramBuild(err)) }
        }
    }

    impl From<ApiWrapperError> for Error {
        fn from(err: ApiWrapperError) -> Self {
            Error { inner: Context::new(ErrorKind::ApiWrapper(err)) }
        }
    }

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