Struct SBError

pub struct SBError {
    pub raw: SBErrorRef,
}

A container for holding any error code and an error message.

An SBError is used to indicate whether or not an operation has succeeded or failed, along with an indication of why it has failed.

To check if the operation has succeeded, use SBError::is_success(). If it has failed, then SBError::is_failure() will return true, and more information about the error can be obtained from SBError::error(), SBError::error_string(), and SBError::error_type().

Fields

raw: SBErrorRef

The underlying raw SBErrorRef.

Implementations

impl SBError

pub fn is_success(&self) -> bool

Does this error represent a success?

An error starts out in the success state by default:

let e = SBError::default();
assert!(e.is_success());

See also:

• SBError::into_result()
• SBError::is_failure()

pub fn is_failure(&self) -> bool

Does this error represent a failure?

See also:

• SBError::error()
• SBError::error_string()
• SBError::error_type()
• SBError::into_result()
• SBError::is_success()

pub fn into_result(self) -> Result<(), SBError>

Convert to a Result<(), SBError>.

An SBError represents either a success or a failure. This method converts the success variant to Ok(()) and the error variant to Err(self).

let e = SBError::default();
// Do something with `e`.
let r = e.into_result();

See also:

• SBError::error()
• SBError::error_string()
• SBError::error_type()

pub fn error(&self) -> u32

The underlying error code. Must be interpreted in conjunction with the error type.

See also:

• SBError::error_string()
• SBError::error_type()

pub fn error_string(&self) -> &str

Any textual error message associated with the error.

See also:

• SBError::error()
• SBError::error_type()

pub fn error_type(&self) -> ErrorType

What type of error is this?

See also:

• SBError::error()
• SBError::error_string()

Trait Implementations

impl Clone for SBError

fn clone(&self) -> SBError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SBError

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SBError

fn default() -> SBError

Returns the “default value” for a type.

impl Display for SBError

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

Formats the value using the given formatter.

impl Drop for SBError

fn drop(&mut self)

Executes the destructor for this type.

impl Error for SBError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

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

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl Send for SBError

impl Sync for SBError