Struct magnus::class::RClass

pub struct RClass(/* private fields */);

A Value pointer to a RClass struct, Ruby’s internal representation of classes.

See the Class trait for methods available on classes. See the Module trait for defining instance methods and nested classes/modules. See the Object trait for defining singlton methods (aka class methods).

See the ReprValue trait for additional methods available on this type.

Implementations

impl RClass

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

Return Some(RClass) if val is a RClass, None otherwise.

Examples

use magnus::{eval, RClass};

assert!(RClass::from_value(eval("String").unwrap()).is_some());
assert!(RClass::from_value(eval("Enumerable").unwrap()).is_none());
assert!(RClass::from_value(eval("nil").unwrap()).is_none());

Trait Implementations

impl Class for RClass

type Instance = Value

The type representing an instance of the class Self.

fn new(superclass: Self) -> Result<Self, Error>

Create a new anonymous class.

fn new_instance<T>(self, args: T) -> Result<Self::Instance, Error>

where T: ArgList,

Create a new object, an instance of self, passing the arguments args to the initialiser.

fn obj_alloc(self) -> Result<Self::Instance, Error>

Create a new object, an instance of self, without calling the class’s initialize method.

fn as_r_class(self) -> RClass

Return self as an RClass.

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

Returns the parent class of self.

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

Return the name of self.

fn define_alloc_func<T>(self)

where T: Default + TypedData,

Define an allocator function for self using T’s Default implementation.

fn undef_default_alloc_func(self)

Remove the allocator function of a class if it is Ruby’s default allocator function.

impl Clone for RClass

fn clone(&self) -> RClass

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RClass

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

Formats the value using the given formatter.

impl Display for RClass

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

Formats the value using the given formatter.

impl IntoValue for RClass

fn into_value_with(self, _: &Ruby) -> Value

Convert self into Value.

fn into_value(self) -> Value

Convert self into Value.

unsafe fn into_value_unchecked(self) -> Value

Convert self into Value.

impl Module for RClass

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

where T: IntoId,

Define a class in self’s scope.

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

where T: IntoId,

Define a module in self’s scope.

fn define_error<T>( self, name: T, superclass: ExceptionClass ) -> Result<ExceptionClass, Error>

where T: IntoId,

Define an exception class 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: IntoId, U: IntoValue,

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

fn const_get<T, U>(self, name: T) -> Result<U, Error>

where T: IntoId, U: TryConvert,

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

fn is_inherited<T>(self, other: T) -> bool

where T: ReprValue + 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: IntoId, 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: IntoId,

Define public accessor methods for the attribute name.

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

where T: IntoId, U: IntoId,

Alias the method src of self as dst.

impl Object for RClass

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: IntoId, 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: IntoId, U: IntoValue,

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 ReprValue for RClass

fn as_value(self) -> Value

Return self as a Value.

fn is_nil(self) -> bool

Returns whether self is Ruby’s nil value.

fn equal<T>(self, other: T) -> Result<bool, Error>

where T: ReprValue,

Checks for equality, delegating to the Ruby method #==.

fn eql<T>(self, other: T) -> Result<bool, Error>

where T: ReprValue,

Checks for equality, delegating to the Ruby method #eql?.

fn hash(self) -> Result<Integer, Error>

Returns an integer non-uniquely identifying self.

fn class(self) -> RClass

Returns the class that self is an instance of.

fn is_frozen(self) -> bool

Returns whether self is ‘frozen’.

fn check_frozen(self) -> Result<(), Error>

Returns an error if self is ‘frozen’.

fn freeze(self)

Mark self as frozen.

fn to_bool(self) -> bool

Convert self to a bool, following Ruby’s rules of false and nil as boolean false and everything else boolean true.

fn funcall<M, A, T>(self, method: M, args: A) -> Result<T, Error>

where M: IntoId, A: ArgList, T: TryConvert,

Call the method named method on self with args.

fn funcall_public<M, A, T>(self, method: M, args: A) -> Result<T, Error>

where M: IntoId, A: ArgList, T: TryConvert,

Call the public method named method on self with args.

fn check_funcall<M, A, T>(self, method: M, args: A) -> Option<Result<T, Error>>

where M: IntoId, A: ArgList, T: TryConvert,

If self responds to the method named method, call it with args.

fn funcall_with_block<M, A, T>( self, method: M, args: A, block: Proc ) -> Result<T, Error>

where M: IntoId, A: ArgList, T: TryConvert,

Call the method named method on self with args and block.

fn block_call<M, A, R, T>( self, method: M, args: A, block: fn(_: &[Value], _: Option<Proc>) -> R ) -> Result<T, Error>

where M: IntoId, A: ArgList, R: BlockReturn, T: TryConvert,

Call the method named method on self with args and block.

fn respond_to<M>(self, method: M, include_private: bool) -> Result<bool, Error>

where M: IntoId,

Check if self responds to the given Ruby method.

fn to_r_string(self) -> Result<RString, Error>

Convert self to a Ruby String.

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

Convert self to a Rust string.

fn inspect(self) -> String

Convert self to its Ruby debug representation.

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

Return the name of self’s class.

fn is_kind_of<T>(self, class: T) -> bool

where T: ReprValue + Module,

Returns whether or not self is an instance of class.

fn enumeratorize<M, A>(self, method: M, args: A) -> Enumerator

where M: IntoSymbol, A: ArgList,

Generate an Enumerator from method on self, passing args to method.

impl TryConvert for RClass

fn try_convert(val: Value) -> Result<Self, Error>

Convert val into Self.

impl Copy for RClass