Struct magnus::module::RModule

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

A Value pointer to a RModule struct, Ruby’s internal representation of modules.

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. See Ruby for methods to create an RModule.

Implementations

impl RModule

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

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

Examples

use magnus::{eval, RModule};

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

pub fn new() -> Self

Create a new anonymous module.

Panics

Panics if called from a non-Ruby thread. See Ruby::module_new for the non-panicking version.

Examples

use magnus::{class, prelude::*, RModule};

let module = RModule::new();
assert!(module.is_kind_of(class::module()));

pub fn define_module_function<M>(self, name: &str, func: M) -> Result<(), Error>

where M: Method,

Define a method in self’s scope as a ‘module function’. This method will be visible as a public ‘class’ method on the module and a private instance method on any object including the module.

Examples

use magnus::{define_module, function, r_string, rb_assert, RString};

fn greet() -> RString {
    r_string!("Hello, world!")
}

let module = define_module("Greeting").unwrap();
module
    .define_module_function("greet", function!(greet, 0))
    .unwrap();

rb_assert!(r#"Greeting.greet == "Hello, world!""#);

rb_assert!(
    r#"
    include Greeting
    greet == "Hello, world!"
"#,
);

Trait Implementations

impl Clone for RModule

fn clone(&self) -> RModule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RModule

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

Formats the value using the given formatter.

impl Display for RModule

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

Formats the value using the given formatter.

impl IntoValue for RModule

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 RModule

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 RModule

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 RModule

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 RModule

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

Convert val into Self.

impl Copy for RModule