Enum artichoke_backend::types::Ruby

pub enum Ruby {
    Array,
    Bool,
    Class,
    CPointer,
    Data,
    Exception,
    Fiber,
    Fixnum,
    Float,
    Hash,
    InlineStruct,
    Module,
    Nil,
    Object,
    Proc,
    Range,
    SingletonClass,
    String,
    Symbol,
    Unreachable,
    RecursiveSelfOwnership,
}

Classes of Ruby types.

Variants

Array

Ruby Array type.

Bool

Ruby TrueClass and FalseClass type.

Class

Ruby Class type.

CPointer

FFI type for a borrowed C pointer.

Data

FFI type for an owned C pointer.

Exception

Ruby Exception type.

Fiber

Ruby Fiber type.

Fixnum

Ruby Fixnum type.

Fixnum is a type of Integer which represents numbers from [-u64::MAX, us64::MAX]. Fixnums have a special algorithm for object IDs: 2 * self - 1.

Float

Ruby Float type.

Hash

Ruby Hash type.

Similar to a HashMap, but iterates by insertion order.

InlineStruct

Internal type for non-heap allocated structs.

Module

Ruby Module type.

Nil

Ruby nil singleton type, the only instance of NilClass.

Object

Ruby Object type.

This type represents instances of classes defined in the Artichoke VM.

Proc

Ruby Proc type.

Proc is a callable closure that captures lexical scope. Procs can be arbitrary arity and may or may not enforce this arity when called.

Range

Ruby Range type.

Similar to a Rust iterator.

SingletonClass

Internal type for the singleton class of an object.

String

Ruby String type.

In Artichoke, Strings have a limited set of encodings. A String can be UTF-8, maybe UTF-8, or binary.

Symbol

Ruby Symbol type.

An interned String. Symbols are never freed by the interpreter.

Unreachable

Unreachable interpreter value. Receiving one of these from the interpreter is a bug.

RecursiveSelfOwnership

A special Value that is a placeholder for collections that own themselves.

Implementations

impl Ruby

#[must_use]pub const fn class_name(self) -> &'static str

Ruby Class name for VM type.

Trait Implementations

impl Clone for Ruby

pub fn clone(&self) -> Ruby

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Ruby

impl Debug for Ruby

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

Formats the value using the given formatter.

impl Display for Ruby

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

Formats the value using the given formatter.

impl Eq for Ruby

impl From<Ruby> for NoBlockGiven

fn from(ruby_type: Ruby) -> Self

Performs the conversion.

impl Hash for Ruby

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for Ruby

pub fn cmp(&self, other: &Ruby) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Ruby> for Ruby

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Ruby> for Ruby

pub fn partial_cmp(&self, other: &Ruby) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Ruby

impl StructuralPartialEq for Ruby