Enum ocl::Error

pub enum Error {
    Void,
    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),
    EmptyInfoResult(EmptyInfoResult),
}

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

VoidConversion(String)Status

Fields of Status

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

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

Methods

impl Error

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

Deprecated since 0.4.0

: Use ::from instead.

Returns a new Error with the description string: desc.

Depricated

Use ::from instead.

fn string<S>(desc: S) -> Error where
    S: Into<String>, 

Deprecated since 0.4.0

: Use ::from instead.

Returns a new Error::String with the given description.

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

Deprecated since 0.4.0

: Use Err("...".into()) instead.

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

Depricated

Use ::err_string or Err("...".into()) instead.

fn err_string<T, S>(desc: S) -> Result<T, Error> where
    S: Into<String>, 

Returns a new Err(ocl_core::Error::String(...)) variant with the given description.

fn eval_errcode<T, S>(
    errcode: i32,
    result: T,
    fn_name: &'static str,
    fn_info: S
) -> Result<T, Error> where
    S: Into<String>, 

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

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

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

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

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 Send for Error

impl Display for Error

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

Formats the value using the given formatter.

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 Debug for Error

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

Formats the value using the given formatter.

impl From<PlatformInfoResult> for Error

fn from(err: PlatformInfoResult) -> Error

Performs the conversion.

impl From<DeviceInfoResult> for Error

fn from(err: DeviceInfoResult) -> Error

Performs the conversion.

impl From<ContextInfoResult> for Error

fn from(err: ContextInfoResult) -> Error

Performs the conversion.

impl From<CommandQueueInfoResult> for Error

fn from(err: CommandQueueInfoResult) -> Error

Performs the conversion.

impl From<MemInfoResult> for Error

fn from(err: MemInfoResult) -> Error

Performs the conversion.

impl From<ImageInfoResult> for Error

fn from(err: ImageInfoResult) -> Error

Performs the conversion.

impl From<SamplerInfoResult> for Error

fn from(err: SamplerInfoResult) -> Error

Performs the conversion.

impl From<ProgramInfoResult> for Error

fn from(err: ProgramInfoResult) -> Error

Performs the conversion.

impl From<ProgramBuildInfoResult> for Error

fn from(err: ProgramBuildInfoResult) -> Error

Performs the conversion.

impl From<KernelInfoResult> for Error

fn from(err: KernelInfoResult) -> Error

Performs the conversion.

impl From<KernelArgInfoResult> for Error

fn from(err: KernelArgInfoResult) -> Error

Performs the conversion.

impl From<KernelWorkGroupInfoResult> for Error

fn from(err: KernelWorkGroupInfoResult) -> Error

Performs the conversion.

impl From<EventInfoResult> for Error

fn from(err: EventInfoResult) -> Error

Performs the conversion.

impl From<ProfilingInfoResult> for Error

fn from(err: ProfilingInfoResult) -> Error

Performs the conversion.

impl From<()> for Error

fn from(()) -> Error

Performs the conversion.

impl From<EmptyInfoResult> for Error

fn from(err: EmptyInfoResult) -> Error

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 From<Error> for OclError

fn from(err: Error) -> OclError

Performs the conversion.