Struct rosy::Module

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

An instance of Ruby's Module type.

Methods

impl Module

pub fn extend(self, object: impl Object) -> Result

Extends object with the contents of self.

pub unsafe fn extend_unchecked(self, object: impl Object)

Extends object with the contents of self.

Safety

The caller must ensure that self is not frozen or else a FrozenError exception will be raised.

pub fn def(name: impl Into<SymbolId>) -> Result<Self, DefMixinError>

Defines a new top-level module with name.

Examples

Defining a new module is straightforward:

let my_mod = rosy::Module::def("MyMod").unwrap();

Attempting to define an existing module will result in an error:

use rosy::Module;

let math = Module::def("Math").unwrap_err().existing_object();
assert_eq!(Module::math(), math.unwrap());

pub fn get(name: impl Into<SymbolId>) -> Option<Self>

Retrieves an existing top-level Module defined by name.

pub unsafe fn get_unchecked(name: impl Into<SymbolId>) -> Self

Retrieves an existing top-level Module defined by name.

Safety

This method does not:

• Check whether an item for name exists (an exception will be thrown if this is the case)
• Check whether the returned item for name is actually a Module

pub fn get_or_def(name: impl Into<SymbolId>) -> Result<Self, DefMixinError>

Retrieves an existing top-level Module defined by name or defines one if it doesn't exist.

pub fn name(self) -> Option<String>

Returns the name of self or nil if anonymous.

pub fn ancestors(self) -> Array<Module>

Returns the ancestors of this module, including itself.

impl Module

Built-in modules.

pub fn kernel() -> Self

The Kernel module.

pub fn comparable() -> Self

The Comparable module.

pub fn enumerable() -> Self

The Enumerable module.

pub fn errno() -> Self

The Errno module.

pub fn file_test() -> Self

The FileTest module.

pub fn gc() -> Self

The GC module.

pub fn math() -> Self

The Math module.

pub fn process() -> Self

The Process module.

pub fn wait_readable() -> Self

The WaitReadable module.

pub fn wait_writable() -> Self

The WaitWritable module.

Trait Implementations

impl Classify for Module

fn class() -> Class<Self>

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

impl Mixin for Module

fn to_class(self) -> Result<Class, Module>

Returns self as a Class if it is one or a Module otherwise.

fn to_module(self) -> Result<Module, Class>

Returns self as a Module if it is one or a Class otherwise.

fn include(self, module: Module)

Embeds the contents of module in self.

#[must_use]

fn includes(self, module: Module) -> bool

Returns whether self or one of its ancestors includes module.

fn included_modules(self) -> Array<Module>

Returns an array of the modules included in self.

fn prepend(self, module: Module)

Prepends module in self.

fn def_class(self, name: impl Into<SymbolId>) -> Result<Class, DefMixinError>

Defines a new class under self with name.

fn def_subclass<S: Object>(
    self,
    superclass: Class<S>,
    name: impl Into<SymbolId>
) -> Result<Class, DefMixinError>

Defines a new subclass of superclass under self with name.

fn get_class(self, name: impl Into<SymbolId>) -> Option<Class>

Returns the existing Class with name in self.

unsafe fn get_class_unchecked(self, name: impl Into<SymbolId>) -> Class

Returns the existing Class with name in self.

fn def_module(self, name: impl Into<SymbolId>) -> Result<Module, DefMixinError>

Defines a new module under self with name.

fn get_module(self, name: impl Into<SymbolId>) -> Option<Module>

Returns the existing Module with name in self.

unsafe fn get_module_unchecked(self, name: impl Into<SymbolId>) -> Module

Returns the existing Module with name in self.

fn has_const(self, name: impl Into<SymbolId>) -> bool

Returns whether a constant for name is defined in self, or in some parent class if not self.

fn get_const(self, name: impl Into<SymbolId>) -> AnyObject

Returns the constant value for name in self, or in some parent class if not self.

fn set_const(self, name: impl Into<SymbolId>, val: impl Object)

Sets the value a constant for name in self to val.

fn remove_const(self, name: impl Into<SymbolId>) -> AnyObject

Removes the constant value for name, returning it.

fn has_class_var(self, var: impl Into<SymbolId>) -> bool

Returns whether the class-level var is defined in self.

fn get_class_var(self, var: impl Into<SymbolId>) -> AnyObject

Returns the class-level var in self.

fn set_class_var<K, V>(self, key: K, val: V) -> Result where
    K: Into<SymbolId>,
    V: Into<AnyObject>, 

Sets the class-level var in self to val.

unsafe fn set_class_var_unchecked<K, V>(self, key: K, val: V) where
    K: Into<SymbolId>,
    V: Into<AnyObject>, 

Sets the class-level var for key in self to val.

fn attr_reader<N: Into<SymbolId>>(self, name: N) -> Result

Defines an read-only attribute on self with name.

unsafe fn attr_reader_unchecked<N: Into<SymbolId>>(self, name: N)

Defines an read-only attribute on self with name.

fn attr_writer<N: Into<SymbolId>>(self, name: N) -> Result

Defines a write-only attribute on self with name.

unsafe fn attr_writer_unchecked<N: Into<SymbolId>>(self, name: N)

Defines a write-only attribute on self with name.

fn attr_accessor<N: Into<SymbolId>>(self, name: N) -> Result

Defines a read-write attribute on self with name.

unsafe fn attr_accessor_unchecked<N: Into<SymbolId>>(self, name: N)

Defines a read-write attribute on self with name.

unsafe fn eval_unchecked(self, args: impl EvalArgs) -> AnyObject

Evaluates args in the context of self.

fn eval(self, args: impl EvalArgs) -> Result<AnyObject>

Evaluates args in the context of self, returning any raised exceptions.

impl Object for Module

fn unique_id() -> Option<u128>

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

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

Attempts to create an instance by casting obj.

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.

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 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 Module

impl Eq for Module

impl AsRef<AnyObject> for Module

fn as_ref(&self) -> &AnyObject

Performs the conversion.

impl Clone for Module

fn clone(&self) -> Module

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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<Module> for AnyObject

fn from(object: Module) -> AnyObject

Performs the conversion.

impl Display for Module

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

Formats the value using the given formatter.

impl Debug for Module

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

Formats the value using the given formatter.