pub struct SBError {
pub raw: SBErrorRef,
}
Expand description
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
sourceimpl SBError
impl SBError
sourcepub fn is_success(&self) -> bool
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:
sourcepub fn is_failure(&self) -> bool
pub fn is_failure(&self) -> bool
Does this error represent a failure?
See also:
sourcepub fn into_result(self) -> Result<(), SBError>
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:
sourcepub fn error(&self) -> u32
pub fn error(&self) -> u32
The underlying error code. Must be interpreted in conjunction with the error type.
See also:
sourcepub fn error_string(&self) -> &str
pub fn error_string(&self) -> &str
Any textual error message associated with the error.
See also:
sourcepub fn error_type(&self) -> ErrorType
pub fn error_type(&self) -> ErrorType
Trait Implementations
sourceimpl Error for SBError
impl Error for SBError
1.30.0 · sourcefn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
1.0.0 · sourcefn description(&self) -> &str
fn description(&self) -> &str
use the Display impl or to_string()