Struct rosy::AnyException

#[repr(transparent)]
pub struct AnyException(_);

Any Ruby exception.

Methods

impl AnyException

pub fn new(message: impl Into<String>) -> Self

Creates a new instance of Exception with message.

pub unsafe fn of_class(
    class: impl Into<Class>,
    message: impl Into<String>
) -> Self

Creates a new instance of class with message.

Safety

The class argument must inherit from an exception class.

pub fn current() -> Option<AnyException>

Returns the current pending exception.

pub fn take_current() -> Option<AnyException>

Returns the current pending exception, removing it from its global spot.

pub fn is_standard_error(self) -> bool

Returns whether self is a StandardError.

pub fn is_system_exit(self) -> bool

Returns whether self is a SystemExit.

pub fn is_interrupt(self) -> bool

Returns whether self is a Interrupt.

pub fn is_signal(self) -> bool

Returns whether self is a Signal.

pub fn is_fatal(self) -> bool

Returns whether self is a Fatal.

pub fn is_arg_error(self) -> bool

Returns whether self is a ArgumentError.

pub fn is_eof_error(self) -> bool

Returns whether self is a EOFError.

pub fn is_index_error(self) -> bool

Returns whether self is a IndexError.

pub fn is_stop_iteration(self) -> bool

Returns whether self is a StopIteration.

pub fn is_key_error(self) -> bool

Returns whether self is a KeyError.

pub fn is_range_error(self) -> bool

Returns whether self is a RangeError.

pub fn is_io_error(self) -> bool

Returns whether self is a IOError.

pub fn is_runtime_error(self) -> bool

Returns whether self is a RuntimeError.

pub fn is_frozen_error(self) -> bool

Returns whether self is a FrozenError.

pub fn is_security_error(self) -> bool

Returns whether self is a SecurityError.

pub fn is_system_call_error(self) -> bool

Returns whether self is a SystemCallError.

pub fn is_thread_error(self) -> bool

Returns whether self is a ThreadError.

pub fn is_type_error(self) -> bool

Returns whether self is a TypeError.

pub fn is_zero_div_error(self) -> bool

Returns whether self is a ZeroDivError.

pub fn is_not_imp_error(self) -> bool

Returns whether self is a NotImpError.

pub fn is_no_mem_error(self) -> bool

Returns whether self is a NoMemError.

pub fn is_no_method_error(self) -> bool

Returns whether self is a NoMethodError.

pub fn is_float_domain_error(self) -> bool

Returns whether self is a FloatDomainErr.

pub fn is_local_jump_error(self) -> bool

Returns whether self is a LocalJumpError.

pub fn is_sys_stack_error(self) -> bool

Returns whether self is a SysStackError.

pub fn is_regexp_error(self) -> bool

Returns whether self is a RegexpError.

pub fn is_encoding_error(self) -> bool

Returns whether self is a EncodingError.

pub fn is_enc_compat_error(self) -> bool

Returns whether self is a EncCompatError.

pub fn is_script_error(self) -> bool

Returns whether self is a ScriptError.

pub fn is_name_error(self) -> bool

Returns whether self is a NameError.

pub fn is_syntax_error(self) -> bool

Returns whether self is a SyntaxError.

pub fn is_load_error(self) -> bool

Returns whether self is a LoadError.

pub fn is_math_domain_error(self) -> bool

Returns whether self is a MathDomainError.

Trait Implementations

impl Exception for AnyException

fn into_any_exception(self) -> AnyException

Returns self as an AnyException.

fn as_any_exception(&self) -> &AnyException

Returns a reference to self as an AnyObject.

unsafe fn raise(self)

Raises the exception.

fn backtrace(&self) -> Option<Array<String>>

Returns a backtrace associated with self.

fn cause(&self) -> Option<AnyException>

The underlying exception that caused self.

impl Classify for AnyException

fn class() -> Class<Self>

Returns the typed class that can be used to get an instance of self.

impl Object for AnyException

fn cast<A: Object>(obj: A) -> Option<Self>

Attempts to create an instance by casting obj.

fn unique_id() -> Option<u128>

Returns a unique identifier for an object type to facilitate casting.

unsafe fn from_raw(raw: usize) -> Self

Creates a new object from raw without checking.

unsafe fn cast_unchecked(obj: impl Object) -> Self

Casts obj to Self without checking its type.

fn into_any_object(self) -> AnyObject

Returns self as an AnyObject.

fn as_any_object(&self) -> &AnyObject

Returns a reference to self as an AnyObject.

fn as_any_slice(&self) -> &[AnyObject]

Returns self as a reference to a single-element slice.

fn raw(self) -> usize

Returns the raw object pointer.

unsafe fn as_unchecked<O: Object>(&self) -> &O

Casts self to O without checking whether it is one.

unsafe fn into_unchecked<O: Object>(self) -> O

Converts self to O without checking whether it is one.

fn id(self) -> u64

Returns the object's identifier.

fn ty(self) -> Ty

Returns the virtual type of self.

fn is_ty(self, ty: Ty) -> bool

Returns whether the virtual type of self is ty.

fn class(self) -> Class<Self>

Returns the Class for self.

fn singleton_class(self) -> Class<Self>

Returns the singleton Class of self, creating one if it doesn't exist already.

fn mark(self)

Marks self for Ruby to avoid garbage collecting it.

unsafe fn force_recycle(self)

Forces the garbage collector to free the contents of self.

fn def_singleton_method<N, F>(self, name: N, f: F) -> Result where
    N: Into<SymbolId>,
    F: MethodFn<Self>, 

Defines a method for name on the singleton class of self that calls f when invoked.

unsafe fn def_singleton_method_unchecked<N, F>(self, name: N, f: F) where
    N: Into<SymbolId>,
    F: MethodFn<Self>, 

Defines a method for name on the singleton class of self that calls f when invoked.

fn call(self, method: impl Into<SymbolId>) -> Result<AnyObject>

Calls method on self and returns the result.

unsafe fn call_unchecked(self, method: impl Into<SymbolId>) -> AnyObject

Calls method on self and returns the result.

fn call_with(
    self,
    method: impl Into<SymbolId>,
    args: &[impl Object]
) -> Result<AnyObject>

Calls method on self with args and returns the result.

unsafe fn call_with_unchecked(
    self,
    method: impl Into<SymbolId>,
    args: &[impl Object]
) -> AnyObject

Calls method on self with args and returns the result.

fn call_public(self, method: impl Into<SymbolId>) -> Result<AnyObject>

Calls the public method on self and returns the result.

unsafe fn call_public_unchecked(self, method: impl Into<SymbolId>) -> AnyObject

Calls the public method on self and returns the result.

fn call_public_with(
    self,
    method: impl Into<SymbolId>,
    args: &[impl Object]
) -> Result<AnyObject>

Calls the public method on self with args and returns the result.

unsafe fn call_public_with_unchecked(
    self,
    method: impl Into<SymbolId>,
    args: &[impl Object]
) -> AnyObject

Calls the public method on self with args and returns the result.

fn inspect(self) -> String

Returns a printable string representation of self.

fn to_s(self) -> String

Returns the result of calling the to_s method on self.

fn is_frozen(self) -> bool

Returns whether modifications can be made to self.

fn freeze(self)

Freezes self, preventing any further mutations.

fn is_eql<O: Object>(self, other: &O) -> bool

Returns whether self is equal to other in terms of the eql? method.

impl Copy for AnyException

impl Eq for AnyException

impl AsRef<AnyObject> for AnyException

fn as_ref(&self) -> &AnyObject

Performs the conversion.

impl Clone for AnyException

fn clone(&self) -> AnyException

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<O: Object> PartialEq<O> for AnyException

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

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

#[must_use]

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

This method tests for !=.

impl From<AnyException> for AnyObject

fn from(obj: AnyException) -> Self

Performs the conversion.

impl From<Infallible> for AnyException

fn from(error: Infallible) -> Self

Performs the conversion.

impl Display for AnyException

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

Formats the value using the given formatter.

impl Debug for AnyException

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

Formats the value using the given formatter.

impl Error for AnyException

fn description(&self) -> &str

This method is soft-deprecated.

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

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

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

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

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

fn type_id(&self) -> TypeId where
    Self: 'static, 

Gets the TypeId of self