Enum artichoke_backend::def::EnclosingRubyScope

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

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

In Ruby, classes and modules can be defined inside of 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

impl EnclosingRubyScope

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.

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.

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 implemention 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.

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 an fqname of A::B::C.

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

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

Trait Implementations

impl Clone for EnclosingRubyScope

fn clone(&self) -> EnclosingRubyScope

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EnclosingRubyScope

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

Formats the value using the given formatter.

impl Hash for EnclosingRubyScope

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<EnclosingRubyScope> for EnclosingRubyScope

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

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

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

This method tests for !=.

impl Eq for EnclosingRubyScope

impl StructuralEq for EnclosingRubyScope

impl StructuralPartialEq for EnclosingRubyScope