Struct ruru::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 Ruru 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 ruru::{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 ruru::{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.

Trait Implementations

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 Debug for AnyObject

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

Formats the value using the given formatter.

impl PartialEq for AnyObject

fn eq(&self, __arg_0: &AnyObject) -> bool

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

fn ne(&self, __arg_0: &AnyObject) -> bool

This method tests for !=.

impl From<Value> for AnyObject

fn from(value: Value) -> Self

Performs the conversion.

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 DataTypeWrapper<T>) -> &mut T

Gets a Rust structure that 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_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_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).

fn send(&self, method: &str, arguments: Vec<AnyObject>) -> AnyObject

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

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

Checks whether the object responds to given method

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>

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