[][src]Enum artichoke_backend::def::EnclosingRubyScope

pub enum EnclosingRubyScope {
    Class(Box<Spec>),
    Module(Box<Spec>),
}

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(Box<Spec>)

Reference to a Ruby Class enclosing scope.

Module(Box<Spec>)

Reference to a Ruby Module enclosing scope.

Implementations

impl EnclosingRubyScope[src]

#[must_use]pub fn class(spec: &Spec) -> Self[src]

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

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

#[must_use]pub fn module(spec: &Spec) -> Self[src]

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>>[src]

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.

#[must_use]pub fn fqname(&self) -> Cow<'_, str>[src]

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[src]

impl Debug for EnclosingRubyScope[src]

impl Eq for EnclosingRubyScope[src]

impl Hash for EnclosingRubyScope[src]

impl PartialEq<EnclosingRubyScope> for EnclosingRubyScope[src]

impl StructuralEq for EnclosingRubyScope[src]

impl StructuralPartialEq for EnclosingRubyScope[src]

Auto Trait Implementations

impl RefUnwindSafe for EnclosingRubyScope

impl !Send for EnclosingRubyScope

impl !Sync for EnclosingRubyScope

impl Unpin for EnclosingRubyScope

impl UnwindSafe for EnclosingRubyScope

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 
[src]