Struct magnus::exception::ExceptionClass

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

A Value known to be an instance of Class and subclass of Exception.

All Value methods should be available on this type through Deref, but some may be missed by this documentation.

Implementations

impl ExceptionClass

pub fn from_value(val: Value) -> Option<Self>

Return Some(ExceptionClass) if val is an ExceptionClass, None otherwise.

Methods from Deref<Target = Value>

pub unsafe fn to_s(&self) -> Result<Cow<'_, str>, Error>

Convert self to a Rust string.

Safety

This may return a direct view of memory owned and managed by Ruby. Ruby may modify or free the memory backing the returned str, the caller must ensure this does not happen.

This can be used safely by immediately calling into_owned on the return value.

Examples

use magnus::{eval, QTRUE};

let value = QTRUE;
// safe as we neve give Ruby a chance to free the string.
let s = unsafe { value.to_s() }.unwrap().into_owned();
assert_eq!(s, "true");

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

Return the name of self’s class.

Safety

Ruby may modify or free the memory backing the returned str, the caller must ensure this does not happen.

This can be used safely by immediately calling into_owned on the return value.

Examples

use magnus::{eval, RHash};

let value = RHash::new();
// safe as we neve give Ruby a chance to free the string.
let s = unsafe { value.classname() }.into_owned();
assert_eq!(s, "Hash");

pub fn try_convert<T>(&self) -> Result<T, Error> where
    T: TryConvert, 

Convert self to the Rust type T.

See the types that TryConvert is implemented on for what this method can convert to.

Examples

use magnus::{eval, Value};

assert_eq!(eval::<Value>("42").unwrap().try_convert::<i64>().unwrap(), 42);
assert_eq!(eval::<Value>("1.23").unwrap().try_convert::<i64>().unwrap(), 1);
assert_eq!(eval::<Value>("1").unwrap().try_convert::<f64>().unwrap(), 1.0);
assert_eq!(eval::<Value>("nil").unwrap().try_convert::<Option<i64>>().unwrap(), None);
assert_eq!(eval::<Value>("42").unwrap().try_convert::<Option<i64>>().unwrap(), Some(42));

Trait Implementations

impl Clone for ExceptionClass

fn clone(&self) -> ExceptionClass

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExceptionClass

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

Formats the value using the given formatter.

impl Default for ExceptionClass

fn default() -> Self

Returns the “default value” for a type.

impl Deref for ExceptionClass

type Target = Value

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for ExceptionClass

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

Formats the value using the given formatter.

impl From<ExceptionClass> for Value

fn from(val: ExceptionClass) -> Self

Converts to this type from the input type.

impl Module for ExceptionClass

fn define_class<T: Into<Id>>(
    self,
    name: T,
    superclass: RClass
) -> Result<RClass, Error>

Define a class in self’s scope.

fn define_module<T: Into<Id>>(self, name: T) -> Result<RModule, Error>

Define a module in self’s scope.

fn include_module(self, module: RModule) -> Result<(), Error>

Include module into self.

fn prepend_module(self, module: RModule) -> Result<(), Error>

Prepend self with module.

fn const_set<T, U>(self, name: T, value: U) -> Result<(), Error> where
    T: Into<Id>,
    U: Into<Value>, 

Set the value for the constant name within self’s scope.

fn const_get<T, U>(self, name: T) -> Result<U, Error> where
    T: Into<Id>,
    U: TryConvert, 

Get the value for the constant name within self’s scope.

fn is_inherited<T>(self, other: T) -> bool where
    T: Deref<Target = Value> + Module, 

Returns whether or not self inherits from other.

fn ancestors(self) -> RArray

Return the classes and modules self inherits, includes, or prepends.

fn define_method<T, M>(self, name: T, func: M) -> Result<(), Error> where
    T: Into<Id>,
    M: Method, 

Define a method in self’s scope.

fn define_private_method<M>(self, name: &str, func: M) -> Result<(), Error> where
    M: Method, 

Define a private method in self’s scope.

fn define_protected_method<M>(self, name: &str, func: M) -> Result<(), Error> where
    M: Method, 

Define a protected method in self’s scope.

fn define_attr<T>(self, name: T, rw: Attr) -> Result<(), Error> where
    T: Into<Id>, 

Define public accessor methods for the attribute name.

fn define_alias<T, U>(self, dst: T, src: U) -> Result<(), Error> where
    T: Into<Id>,
    U: Into<Id>, 

Alias the method src of self as dst.

impl Object for ExceptionClass

fn define_singleton_method<M>(self, name: &str, func: M) -> Result<(), Error> where
    M: Method, 

Define a singleton method in self’s scope.

fn ivar_get<T, U>(self, name: T) -> Result<U, Error> where
    T: Into<Id>,
    U: TryConvert, 

Get the value for the instance variable name within self’s scope.

fn ivar_set<T, U>(self, name: T, value: U) -> Result<(), Error> where
    T: Into<Id>,
    U: Into<Value>, 

Set the value for the instance variable name within self’s scope.

fn singleton_class(self) -> Result<RClass, Error>

Finds or creates the singleton class of self.

fn extend_object(self, module: RModule) -> Result<(), Error>

Extend self with module.

impl Copy for ExceptionClass

impl ReprValue for ExceptionClass