#[repr(transparent)]pub struct RModule(_);
Expand description
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).
All Value
methods should be available on this type through Deref
,
but some may be missed by this documentation.
Implementations§
source§impl RModule
impl RModule
sourcepub fn from_value(val: Value) -> Option<Self>
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());
sourcepub fn new() -> Self
pub fn new() -> Self
Create a new anonymous module.
Examples
use magnus::{class, RModule};
let module = RModule::new();
assert!(module.is_kind_of(class::module()));
sourcepub fn define_module_function<M>(self, name: &str, func: M) -> Result<(), Error>where
M: Method,
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, eval, function, r_string, RString};
fn greet() -> RString {
r_string!("Hello, world!")
}
let module = define_module("Greeting").unwrap();
module.define_module_function("greet", function!(greet, 0)).unwrap();
let res = eval::<bool>(r#"Greeting.greet == "Hello, world!""#).unwrap();
assert!(res);
let res = eval::<bool>(r#"
include Greeting
greet == "Hello, world!"
"#).unwrap();
assert!(res);
Methods from Deref<Target = Value>§
sourcepub unsafe fn to_s(&self) -> Result<Cow<'_, str>, Error>
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");
sourcepub unsafe fn classname(&self) -> Cow<'_, str>
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 never give Ruby a chance to free the string.
let s = unsafe { value.classname() }.into_owned();
assert_eq!(s, "Hash");
Trait Implementations§
source§impl Module for RModule
impl Module for RModule
source§fn define_class<T: Into<Id>>(
self,
name: T,
superclass: RClass
) -> Result<RClass, Error>
fn define_class<T: Into<Id>>(
self,
name: T,
superclass: RClass
) -> Result<RClass, Error>
self
’s scope. Read moresource§fn define_module<T: Into<Id>>(self, name: T) -> Result<RModule, Error>
fn define_module<T: Into<Id>>(self, name: T) -> Result<RModule, Error>
self
’s scope. Read moresource§fn define_error<T: Into<Id>>(
self,
name: T,
superclass: ExceptionClass
) -> Result<ExceptionClass, Error>
fn define_error<T: Into<Id>>(
self,
name: T,
superclass: ExceptionClass
) -> Result<ExceptionClass, Error>
self
’s scope. Read moresource§fn const_set<T, U>(self, name: T, value: U) -> Result<(), Error>where
T: Into<Id>,
U: Into<Value>,
fn const_set<T, U>(self, name: T, value: U) -> Result<(), Error>where
T: Into<Id>,
U: Into<Value>,
source§fn ancestors(self) -> RArray
fn ancestors(self) -> RArray
self
inherits, includes, or prepends. Read moresource§fn define_method<T, M>(self, name: T, func: M) -> Result<(), Error>where
T: Into<Id>,
M: Method,
fn define_method<T, M>(self, name: T, func: M) -> Result<(), Error>where
T: Into<Id>,
M: Method,
self
’s scope. Read moresource§fn define_private_method<M>(self, name: &str, func: M) -> Result<(), Error>where
M: Method,
fn define_private_method<M>(self, name: &str, func: M) -> Result<(), Error>where
M: Method,
self
’s scope. Read moresource§fn define_protected_method<M>(self, name: &str, func: M) -> Result<(), Error>where
M: Method,
fn define_protected_method<M>(self, name: &str, func: M) -> Result<(), Error>where
M: Method,
self
’s scope. Read moresource§impl Object for RModule
impl Object for RModule
source§fn define_singleton_method<M>(self, name: &str, func: M) -> Result<(), Error>where
M: Method,
fn define_singleton_method<M>(self, name: &str, func: M) -> Result<(), Error>where
M: Method,
self
’s scope. Read more