Struct rutie::AnyObject

pub struct AnyObject { /* fields omitted */ }

Representation of any Ruby object while its type is unknown

As Ruby is a dynamically typed language, at some points Rutie does not know the exact Ruby type of the object, for example:

• Retrieving an object from array;

• Retrieving an object from hash;

• Receiving arguments to a method;

• Initializing a new instance of a non-built-in class.

In these cases you should cast AnyObject to the required type.

Examples

Retrieving an object from Array

use rutie::{Array, Fixnum, Object, VM};

let array = Array::new().push(Fixnum::new(1));
let value = array.at(0).try_convert_to::<Fixnum>(); // `Array::at()` returns `AnyObject`

assert_eq!(value, Ok(Fixnum::new(1)));

Retrieving an object from Hash

use rutie::{Fixnum, Hash, Object, Symbol, VM};

let mut hash = Hash::new();

hash.store(Symbol::new("key"), Fixnum::new(1));

// `Hash::at()` returns `AnyObject`
let value = hash.at(&Symbol::new("key")).try_convert_to::<Fixnum>();

assert_eq!(value, Ok(Fixnum::new(1)));

You can find more examples in Class, Object and VerifiedObject documentation.

Methods from Deref<Target = Value>

pub fn is_true(&self) -> bool

pub fn is_false(&self) -> bool

pub fn is_nil(&self) -> bool

pub fn is_node(&self) -> bool

pub fn is_undef(&self) -> bool

pub fn is_symbol(&self) -> bool

pub fn is_fixnum(&self) -> bool

pub fn is_flonum(&self) -> bool

pub fn is_frozen(&self) -> bool

pub fn ty(&self) -> ValueType

Trait Implementations

impl Object for AnyObject

fn value(&self) -> Value

Returns internal value of current object.

fn class(&self) -> Class

Returns a class of current object.

fn singleton_class(&self) -> Class

Returns a singleton class of current object.

fn get_data<'a, T>(&'a self, wrapper: &'a dyn DataTypeWrapper<T>) -> &T

Gets an immutable reference to the Rust structure which is wrapped into a Ruby object.

fn get_data_mut<'a, T>(
    &'a mut self,
    wrapper: &'a dyn DataTypeWrapper<T>
) -> &mut T

Gets a mutable reference to the Rust structure which is wrapped into a Ruby object.

fn define<F: Fn(&mut Self)>(&mut self, f: F) -> &Self

Wraps calls to the object.

fn define_method<I: Object, O: Object>(
    &mut self,
    name: &str,
    callback: Callback<I, O>
)

Defines an instance method for the given class or object.

fn define_private_method<I: Object, O: Object>(
    &mut self,
    name: &str,
    callback: Callback<I, O>
)

Defines a private instance method for the given class or object.

fn define_singleton_method<I: Object, O: Object>(
    &mut self,
    name: &str,
    callback: Callback<I, O>
)

Defines a class method for given class or singleton method for object.

fn def<I: Object, O: Object>(&mut self, name: &str, callback: Callback<I, O>)

An alias for define_method (similar to Ruby syntax def some_method).

fn def_private<I: Object, O: Object>(
    &mut self,
    name: &str,
    callback: Callback<I, O>
)

An alias for define_private_method (similar to Ruby syntax private def some_method).

fn def_self<I: Object, O: Object>(
    &mut self,
    name: &str,
    callback: Callback<I, O>
)

An alias for define_singleton_method (similar to Ruby def self.some_method).

unsafe fn send(&self, method: &str, arguments: &[AnyObject]) -> AnyObject

Calls a given method on an object similarly to Ruby Object#send method

fn equals<T: Object>(&self, other: &T) -> bool

Alias for Ruby's ==

fn case_equals<T: Object>(&self, other: &T) -> bool

Alias for Ruby's ===

fn is_eql<T: Object>(&self, other: &T) -> bool

Alias for Ruby's eql?

fn is_equal<T: Object>(&self, other: &T) -> bool

Alias for Ruby's equal?

fn respond_to(&self, method: &str) -> bool

Checks whether the object responds to given method

fn protect_send(
    &self,
    method: &str,
    arguments: &[AnyObject]
) -> Result<AnyObject, AnyException>

protect_send returns Result<AnyObject, AnyObject>

fn protect_public_send(
    &self,
    method: &str,
    arguments: &[AnyObject]
) -> Result<AnyObject, AnyException>

protect_public_send returns Result<AnyObject, AnyObject>

fn is_nil(&self) -> bool

Checks whether the object is nil

fn to_any_object(&self) -> AnyObject

Converts struct to AnyObject

fn instance_variable_get(&self, variable: &str) -> AnyObject

Gets an instance variable of object

fn instance_variable_set<T: Object>(
    &mut self,
    variable: &str,
    value: T
) -> AnyObject

Sets an instance variable for object

fn is_frozen(&self) -> bool

Returns the freeze status of the object.

fn freeze(&mut self) -> Self

Prevents further modifications to the object.

unsafe fn to<T: Object>(&self) -> T

Unsafely casts current object to the specified Ruby type

fn try_convert_to<T: VerifiedObject>(&self) -> Result<T, AnyException>

Safely casts current object to the specified Ruby type

fn ty(&self) -> ValueType

Determines the value type of the object

impl VerifiedObject for AnyObject

fn is_correct_type<T: Object>(_: &T) -> bool

fn error_message() -> &'static str

impl TryConvert<AnyObject> for AnyException

type Nil = NilClass

The type returned in the event of a conversion error.

fn try_convert(obj: AnyObject) -> Result<Self, NilClass>

Performs the conversion.

impl TryConvert<AnyObject> for RString

Implicit or nil conversion

Examples

use rutie::{RString, Fixnum, VM, TryConvert, NilClass, Object};

let four = Fixnum::new(4);
let result = RString::try_convert(four.to_any_object());

assert_eq!(result, Err(NilClass::new()));

let five = RString::new_utf8("5");
let result2 = RString::try_convert(five.to_any_object());

if let Ok(r) = result2 {
  assert_eq!(r.to_str(), "5")
} else {
  unreachable!()
}

Ruby:

four = 4
result = String.try_convert(four)

result == nil

five = "5"
result = String.try_convert(five)

result == "5"

type Nil = NilClass

The type returned in the event of a conversion error.

fn try_convert(obj: AnyObject) -> Result<Self, NilClass>

Performs the conversion.

impl Clone for AnyObject

fn clone(&self) -> AnyObject

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<AnyObject> for AnyObject

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

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

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

This method tests for !=.

impl From<Value> for AnyObject

fn from(value: Value) -> Self

Performs the conversion.

impl<'_, T: Object> From<&'_ T> for AnyObject

fn from(value: &T) -> Self

Performs the conversion.

impl AsRef<Value> for AnyObject

fn as_ref(&self) -> &Value

Performs the conversion.

impl AsRef<AnyObject> for AnyObject

fn as_ref(&self) -> &Self

Performs the conversion.

impl Into<Value> for AnyObject

fn into(self) -> Value

Performs the conversion.

impl Into<AnyObject> for AnyException

fn into(self) -> AnyObject

Performs the conversion.

impl Into<AnyObject> for Array

fn into(self) -> AnyObject

Performs the conversion.

impl Into<AnyObject> for Binding

fn into(self) -> AnyObject

Performs the conversion.

impl Into<AnyObject> for Boolean

fn into(self) -> AnyObject

Performs the conversion.

impl Into<AnyObject> for Class

fn into(self) -> AnyObject

Performs the conversion.

impl Into<AnyObject> for Encoding

fn into(self) -> AnyObject

Performs the conversion.

impl Into<AnyObject> for Enumerator

fn into(self) -> AnyObject

Performs the conversion.

impl Into<AnyObject> for Fixnum

fn into(self) -> AnyObject

Performs the conversion.

impl Into<AnyObject> for Float

fn into(self) -> AnyObject

Performs the conversion.

impl Into<AnyObject> for Hash

fn into(self) -> AnyObject

Performs the conversion.

impl Into<AnyObject> for Integer

fn into(self) -> AnyObject

Performs the conversion.

impl Into<AnyObject> for Module

fn into(self) -> AnyObject

Performs the conversion.

impl Into<AnyObject> for NilClass

fn into(self) -> AnyObject

Performs the conversion.

impl Into<AnyObject> for Proc

fn into(self) -> AnyObject

Performs the conversion.

impl Into<AnyObject> for RString

fn into(self) -> AnyObject

Performs the conversion.

impl Into<AnyObject> for Thread

fn into(self) -> AnyObject

Performs the conversion.

impl Into<AnyObject> for Symbol

fn into(self) -> AnyObject

Performs the conversion.

impl Deref for AnyObject

type Target = Value

The resulting type after dereferencing.

fn deref(&self) -> &Value

Dereferences the value.

impl Debug for AnyObject

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

Formats the value using the given formatter.

impl FromIterator<AnyObject> for Array

Converts an iterator into Array.

Examples

use rutie::{Array, Fixnum, Object, VM};

let array: Array = (1..6)
    .map(|num| num * 2)
    .map(|num| Fixnum::new(num).to_any_object())
    .collect();

assert_eq!(array.length(), 5);

for i in 0..5 {
    let expected_number = (i + 1) * 2;

    assert_eq!(array.at(i).try_convert_to::<Fixnum>().unwrap().to_i64(), expected_number);
}

fn from_iter<I: IntoIterator<Item = AnyObject>>(iter: I) -> Self

Creates a value from an iterator.

impl Borrow<Value> for AnyObject

fn borrow(&self) -> &Value

Immutably borrows from an owned value.