pub enum EnclosingRubyScope {
    Class(ClassScope),
    Module(ModuleScope),
}
Expand description

Typesafe wrapper for the RClass * of the enclosing scope for an mruby Module or Class.

In Ruby, classes and modules can be defined inside another class or module. mruby only supports resolving RClass pointers relative to an enclosing scope. This can be the top level with mrb_class_get and mrb_module_get or it can be under another class with mrb_class_get_under or module with mrb_module_get_under.

Because there is no C API to resolve class and module names directly, each class-like holds a reference to its enclosing scope so it can recursively resolve its enclosing RClass *.

Variants§

§

Class(ClassScope)

Reference to a Ruby Class enclosing scope.

§

Module(ModuleScope)

Reference to a Ruby Module enclosing scope.

Implementations§

source§

impl EnclosingRubyScope

source

pub fn class(spec: &Spec) -> Self

Factory for EnclosingRubyScope::Class that clones a class::Spec.

This function is useful when extracting an enclosing scope from the class registry.

source

pub fn module(spec: &Spec) -> Self

Factory for EnclosingRubyScope::Module that clones a module::Spec.

This function is useful when extracting an enclosing scope from the module registry.

source

pub unsafe fn rclass(&self, mrb: *mut mrb_state) -> Option<NonNull<RClass>>

Resolve the RClass * of the wrapped class or module.

Return None if the class-like has no EnclosingRubyScope.

The current implementation results in recursive calls to this function for each enclosing scope.

Safety

This function must be called within an Artichoke::with_ffi_boundary closure because the FFI APIs called in this function may require access to the Artichoke State.

source

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

Get the fully-qualified name of the wrapped class or module.

For example, in the following Ruby code, C has a fully-qualified name of A::B::C.

module A
  class B
    module C
      CONST = 1
    end
  end
end

The current implementation results in recursive calls to this function for each enclosing scope.

Trait Implementations§

source§

impl Clone for EnclosingRubyScope

source§

fn clone(&self) -> EnclosingRubyScope

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for EnclosingRubyScope

source§

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

Formats the value using the given formatter. Read more
source§

impl Hash for EnclosingRubyScope

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl PartialEq<EnclosingRubyScope> for EnclosingRubyScope

source§

fn eq(&self, other: &EnclosingRubyScope) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Eq for EnclosingRubyScope

source§

impl StructuralEq for EnclosingRubyScope

source§

impl StructuralPartialEq for EnclosingRubyScope

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere
    T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere
    T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere
    T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere
    U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere
    T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere
    U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere
    U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.