# Struct ocl::error::Error [−] [src]

    pub struct Error { /* fields omitted */ }

An Error.

## Methods

### `impl Error`
[src]

#### `pub fn api_status(&self) -> Option<Status>`
[src]

Returns the error status code for `OclCore` variants.

#### `pub fn kind(&self) -> &ErrorKind`
[src]

Returns the error variant and contents.

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

Returns the immediate cause of this error (e.g. the next error in the chain).

## Trait Implementations

### `impl Fail for Error`
[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,`
[src]

Provides context for this failure. Read more

#### `fn compat(self) -> Compat<Self>`
[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 + 'static);`
`fn causes(&self) -> Causes`
[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 + 'static)`
[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 Display for Error`
[src]

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

Formats the value using the given formatter. Read more

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

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

Formats the value using the given formatter. Read more

### `impl From<OclCoreError> for Error`
[src]

#### `fn from(err: OclCoreError) -> Error`
[src]

Performs the conversion.

### `impl<T> From<SendError<T>> for Error`
[src]

#### `fn from(err: SendError<T>) -> Error`
[src]

Performs the conversion.

### `impl From<OneshotCanceled> for Error`
[src]

#### `fn from(err: OneshotCanceled) -> Error`
[src]

Performs the conversion.

### `impl From<String> for Error`
[src]

#### `fn from(desc: String) -> Error`
[src]

Performs the conversion.

### `impl<'a> From<&'a str> for Error`
[src]

#### `fn from(desc: &'a str) -> Error`
[src]

Performs the conversion.

### `impl From<NulError> for Error`
[src]

#### `fn from(err: NulError) -> Error`
[src]

Performs the conversion.

### `impl From<Error> for Error`
[src]

#### `fn from(err: Error) -> Error`
[src]

Performs the conversion.

### `impl From<BufferCmdError> for Error`
[src]

#### `fn from(err: BufferCmdError) -> Error`
[src]

Performs the conversion.

### `impl From<Error> for String`
[src]

#### `fn from(err: Error) -> String`
[src]

Performs the conversion.

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

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

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