Struct artichoke::prelude::Exception

pub struct Exception { /* fields omitted */ }

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

impl Exception

#[must_use]

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");

#[must_use]

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");

#[must_use]

pub fn message(&self) -> &[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");

#[must_use]

pub const fn name(&self) -> &'static str

Return this Ruby exception’s class name.

Examples

let exception = Exception::new();
assert_eq!(exception.name(), "Exception");

Trait Implementations

impl Clone for Exception

pub fn clone(&self) -> Exception

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Exception

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

Formats the value using the given formatter.

impl Default for Exception

pub fn default() -> Exception

Returns the “default value” for a type.

impl Display for Exception

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

Formats the value using the given formatter.

impl Error for Exception

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

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

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

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

impl From<&'static [u8]> for Exception

pub fn from(message: &'static [u8]) -> Exception

Performs the conversion.

impl From<&'static str> for Exception

pub fn from(message: &'static str) -> Exception

Performs the conversion.

impl From<Cow<'static, [u8]>> for Exception

pub fn from(message: Cow<'static, [u8]>) -> Exception

Performs the conversion.

impl From<Cow<'static, str>> for Exception

pub fn from(message: Cow<'static, str>) -> Exception

Performs the conversion.

impl From<Exception> for Error

pub fn from(exception: Exception) -> Error

Performs the conversion.

impl From<String> for Exception

pub fn from(message: String) -> Exception

Performs the conversion.

impl From<Vec<u8, Global>> for Exception

pub fn from(message: Vec<u8, Global>) -> Exception

Performs the conversion.

impl Hash for Exception

pub fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Exception

pub fn cmp(&self, other: &Exception) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Exception> for Exception

pub fn eq(&self, other: &Exception) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &Exception) -> bool

This method tests for !=.

impl PartialOrd<Exception> for Exception

pub fn partial_cmp(&self, other: &Exception) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl RubyException for Exception

pub fn message(&self) -> Cow<'_, [u8]>

Message of the Exception.

pub fn name(&self) -> Cow<'_, str>

Class name of the Exception.

pub fn vm_backtrace(
    &self,
    interp: &mut Artichoke
) -> Option<Vec<Vec<u8, Global>, Global>>

Optional backtrace specified by a Vec of frames.

pub fn as_mrb_value(&self, interp: &mut Artichoke) -> Option<mrb_value>

Return a raiseable sys::mrb_value.

impl RubyException for Exception

pub fn message(&self) -> Cow<'_, [u8]>

The exception’s message.

pub fn name(&self) -> Cow<'_, str>

The exception’s class name.

impl Eq for Exception

impl StructuralEq for Exception

impl StructuralPartialEq for Exception