pub struct Exception { /* private fields */ }
Expand description
Ruby Exception
error type.
Descendants of class Exception
are used to communicate between
Kernel#raise
and rescue
statements in begin ... end
blocks.
Exception objects carry information about the exception – its type (the
exception’s class name), an optional descriptive string, and optional
traceback information. Exception
subclasses may add additional information
like NameError#name
.
Implementations
sourceimpl Exception
impl Exception
sourcepub const fn new() -> Exception
pub const fn new() -> Exception
Construct a new, default Exception
Ruby exception.
This constructor sets the exception message to Exception
.
Examples
let exception = Exception::new();
assert_eq!(exception.message(), b"Exception");
sourcepub const fn with_message(message: &'static str) -> Exception
pub const fn with_message(message: &'static str) -> Exception
Construct a new, Exception
Ruby exception with the given
message.
Examples
let exception = Exception::with_message("an error occurred");
assert_eq!(exception.message(), b"an error occurred");
sourcepub fn message(&self) -> &[u8]ⓘNotable traits for &[u8]impl Read for &[u8]impl Write for &mut [u8]
pub fn message(&self) -> &[u8]ⓘNotable traits for &[u8]impl Read for &[u8]impl Write for &mut [u8]
Return the message this Ruby exception was constructed with.
Examples
let exception = Exception::new();
assert_eq!(exception.message(), b"Exception");
let exception = Exception::from("something went wrong");
assert_eq!(exception.message(), b"something went wrong");
Trait Implementations
sourceimpl Error for Exception
impl Error for Exception
1.30.0 · sourcefn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
1.0.0 · sourcefn description(&self) -> &str
fn description(&self) -> &str
use the Display impl or to_string()
sourceimpl Ord for Exception
impl Ord for Exception
1.21.0 · sourcefn max(self, other: Self) -> Self
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
1.21.0 · sourcefn min(self, other: Self) -> Self
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Self where
Self: PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Self where
Self: PartialOrd<Self>,
Restrict a value to a certain interval. Read more
sourceimpl PartialOrd<Exception> for Exception
impl PartialOrd<Exception> for Exception
sourcefn partial_cmp(&self, other: &Exception) -> Option<Ordering>
fn partial_cmp(&self, other: &Exception) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl RubyException for Exception
impl RubyException for Exception
sourcefn vm_backtrace(
&self,
interp: &mut Artichoke
) -> Option<Vec<Vec<u8, Global>, Global>>
fn vm_backtrace(
&self,
interp: &mut Artichoke
) -> Option<Vec<Vec<u8, Global>, Global>>
Optional backtrace specified by a Vec
of frames.
sourcefn as_mrb_value(&self, interp: &mut Artichoke) -> Option<mrb_value>
fn as_mrb_value(&self, interp: &mut Artichoke) -> Option<mrb_value>
Return a raise-able sys::mrb_value
.
sourceimpl RubyException for Exception
impl RubyException for Exception
impl Eq for Exception
impl StructuralEq for Exception
impl StructuralPartialEq for Exception
Auto Trait Implementations
impl RefUnwindSafe for Exception
impl Send for Exception
impl Sync for Exception
impl Unpin for Exception
impl UnwindSafe for Exception
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more