Enum ocl_core::error::Error

pub enum Error {
    Conversion(String),
    Status {
        status: Status,
        status_string: String,
        fn_name: &'static str,
        fn_info: String,
        desc: String,
    },
    String(String),
    Nul(NulError),
    Io(Error),
    FromUtf8Error(FromUtf8Error),
    UnspecifiedDimensions,
    IntoStringError(IntoStringError),
}

An enum containing either a String or one of several other error types.

Implements the usual error traits.

Stability

The String variant may eventually be removed. Many more variants and sub-types will be added as time goes on and things stabilize.

Status will eventually be changed internally to contain a sub-error type unique to each function which generates it (yeah that'll be fun to implement).

UnspecifiedDimensions may be moved into a sub-type.

For now, don't assume the existence of or check for any of the above.

Variants

Conversion(String)Status

Fields

status: Status
status_string: String
fn_name: &'static str
fn_info: String
desc: String

String(String)Nul(NulError)Io(Error)FromUtf8Error(FromUtf8Error)UnspecifiedDimensionsIntoStringError(IntoStringError)

Methods

impl Error

fn new<S: Into<String>>(desc: S) -> Error

Returns a new Error with the description string: desc.

fn err<T, S: Into<String>>(desc: S) -> Result<T>

Returns a new ocl::Result::Err containing an ocl::Error::String variant with the given description.

fn err_status<T: Default, S: Into<String>>(errcode: i32,
                                           fn_name: &'static str,
                                           fn_info: S)
                                           -> Result<T>

Returns a new ocl::Result::Err containing an ocl::Error with the given error code and description.

fn err_conversion<T, S: Into<String>>(desc: S) -> Result<T>

Returns a new ocl::Result::Err containing an ocl::Error::Conversion variant with the given description.

fn prepend<'s, S: AsRef<&'s str>>(&'s mut self, txt: S)

If this is a String variant, concatenate txt to the front of the contained string. Otherwise, do nothing at all.

fn status(&self) -> Option<Status>

Returns the error status code for Status variants.

Trait Implementations

impl Error for Error

fn description(&self) -> &str

A short description of the error.

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

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

impl Into<String> for Error

fn into(self) -> String

Performs the conversion.

impl From<String> for Error

fn from(desc: String) -> Error

Performs the conversion.

impl<'a> From<&'a str> for Error

fn from(desc: &'a str) -> Error

Performs the conversion.

impl From<NulError> for Error

fn from(err: NulError) -> Error

Performs the conversion.

impl From<Error> for Error

fn from(err: Error) -> Error

Performs the conversion.

impl From<FromUtf8Error> for Error

fn from(err: FromUtf8Error) -> Error

Performs the conversion.

impl From<IntoStringError> for Error

fn from(err: IntoStringError) -> Error

Performs the conversion.

impl Display for Error

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Debug for Error

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.