Struct rosy::object::AnyObject

#[repr(transparent)]
pub struct AnyObject { /* fields omitted */ }

An instance of any Ruby object.

Methods

impl AnyObject

pub fn convert_slice(objects: &[impl Object]) -> &[AnyObject]

Casts the concrete slice objects into a slice of AnyObject.

pub fn call_super() -> Result<AnyObject>

Calls super on the current receiver without any arguments in the context of a method.

pub unsafe fn call_super_unchecked() -> AnyObject

Calls super on the current receiver without any arguments in the context of a method, without checking for an exception.

pub fn call_super_with(args: &[impl Object]) -> Result<AnyObject>

Calls super on the current receiver with args in the context of a method.

pub unsafe fn call_super_with_unchecked(args: &[impl Object]) -> AnyObject

Calls super on the current receiver with args in the context of a method, without checking for an exception.

pub const unsafe fn from_raw(raw: usize) -> AnyObject

An alternative to Object::from_raw that works in a const context.

pub const fn nil() -> AnyObject

Returns a nil instance.

pub const fn from_bool(b: bool) -> AnyObject

Returns an instance from a boolean.

pub fn is_nil(self) -> bool

Returns whether self is nil.

pub fn is_undefined(self) -> bool

Returns whether self is undefined.

pub fn is_true(self) -> bool

Returns whether self is true.

pub fn is_false(self) -> bool

Returns whether self is false.

pub fn to_bool(self) -> Option<bool>

Returns the boolean value for self, if any.

pub fn is_fixnum(self) -> bool

Returns whether self is a fixed-sized number.

pub fn is_bignum(self) -> bool

Returns whether self is a variable-sized number.

pub fn is_integer(self) -> bool

Returns whether self is a fixed-sized number.

pub fn to_integer(self) -> Option<Integer>

Returns self as an Integer if it is one.

pub fn is_float(self) -> bool

Returns whether self is a floating point number type.

pub fn is_string(self) -> bool

Returns whether self is a String.

pub fn to_string(self) -> Option<String>

Returns self as a String if it is one.

pub fn is_symbol(self) -> bool

Returns whether self is a Symbol.

pub fn to_symbol(self) -> Option<Symbol>

Returns self as a Symbol if it is one.

pub fn is_array(self) -> bool

Returns whether self is an Array.

pub fn to_array(self) -> Option<Array>

Returns self as an Array if it is one.

Safety

If self refers to an Array<X> and after this method objects of type Y are inserted, expect nasal demons. You've been warned.

pub fn is_class(self) -> bool

Returns whether self is a Class.

pub fn to_class(self) -> Option<Class>

Returns self as a Class if it is one.

pub fn is_module(self) -> bool

Returns whether self is a Module.

pub fn to_module(self) -> Option<Module>

Returns self as a Module if it is one.

pub fn is_exception(self) -> bool

Returns whether self is an Exception.

pub fn to_exception(self) -> Option<AnyException>

Returns self as an AnyException if it is one.

Trait Implementations

impl Object for AnyObject

fn unique_id() -> Option<u128>

Returns a unique identifier for an object type to facilitate casting.

unsafe fn from_raw(raw: usize) -> Self

Creates a new object from raw without checking.

fn cast<A: Object>(obj: A) -> Option<Self>

Attempts to create an instance by casting obj.

fn ty(self) -> Ty

Returns the virtual type of self.

fn raw(self) -> usize

Returns the raw object pointer.

fn as_any_object(&self) -> &Self

Returns a reference to self as an AnyObject.

fn into_any_object(self) -> Self

Returns self as an AnyObject.

unsafe fn cast_unchecked(obj: impl Object) -> Self

Casts obj to Self without checking its type.

fn as_any_slice(&self) -> &[AnyObject]

Returns self as a reference to a single-element slice.

unsafe fn as_unchecked<O: Object>(&self) -> &O

Casts self to O without checking whether it is one.

unsafe fn into_unchecked<O: Object>(self) -> O

Converts self to O without checking whether it is one.

fn id(self) -> u64

Returns the object's identifier.

fn is_ty(self, ty: Ty) -> bool

Returns whether the virtual type of self is ty.

fn class(self) -> Class

Returns the Class for self.

fn singleton_class(self) -> Class

Returns the singleton Class of self, creating one if it doesn't exist already.

fn mark(self)

Marks self for Ruby to avoid garbage collecting it.

unsafe fn force_recycle(self)

Forces the garbage collector to free the contents of self.

fn def_singleton_method<N, F>(self, name: N, f: F) -> Result where
    N: Into<SymbolId>,
    F: MethodFn, 

Defines a method for name on the singleton class of self that calls f when invoked.

unsafe fn def_singleton_method_unchecked<N, F>(self, name: N, f: F) where
    N: Into<SymbolId>,
    F: MethodFn, 

Defines a method for name on the singleton class of self that calls f when invoked.

fn call(self, method: impl Into<SymbolId>) -> Result<AnyObject>

Calls method on self and returns the result.

unsafe fn call_unchecked(self, method: impl Into<SymbolId>) -> AnyObject

Calls method on self and returns the result.

fn call_with(
    self,
    method: impl Into<SymbolId>,
    args: &[impl Object]
) -> Result<AnyObject>

Calls method on self with args and returns the result.

unsafe fn call_with_unchecked(
    self,
    method: impl Into<SymbolId>,
    args: &[impl Object]
) -> AnyObject

Calls method on self with args and returns the result.

fn call_public(self, method: impl Into<SymbolId>) -> Result<AnyObject>

Calls the public method on self and returns the result.

unsafe fn call_public_unchecked(self, method: impl Into<SymbolId>) -> AnyObject

Calls the public method on self and returns the result.

fn call_public_with(
    self,
    method: impl Into<SymbolId>,
    args: &[impl Object]
) -> Result<AnyObject>

Calls the public method on self with args and returns the result.

unsafe fn call_public_with_unchecked(
    self,
    method: impl Into<SymbolId>,
    args: &[impl Object]
) -> AnyObject

Calls the public method on self with args and returns the result.

fn inspect(self) -> String

Returns a printable string representation of self.

fn to_s(self) -> String

Returns the result of calling the to_s method on self.

fn is_frozen(self) -> bool

Returns whether modifications can be made to self.

fn freeze(self)

Freezes self, preventing any further mutations.

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

Returns whether self is equal to other in terms of the eql? method.

impl<O: Object> AsRef<AnyObject> for Array<O>

fn as_ref(&self) -> &AnyObject

Performs the conversion.

impl AsRef<AnyObject> for AnyException

fn as_ref(&self) -> &AnyObject

Performs the conversion.

impl<K: Object, V: Object> AsRef<AnyObject> for Hash<K, V>

fn as_ref(&self) -> &AnyObject

Performs the conversion.

impl AsRef<AnyObject> for Integer

fn as_ref(&self) -> &AnyObject

Performs the conversion.

impl AsRef<AnyObject> for Class

fn as_ref(&self) -> &AnyObject

Performs the conversion.

impl AsRef<AnyObject> for Module

fn as_ref(&self) -> &AnyObject

Performs the conversion.

impl AsRef<AnyObject> for AnyObject

fn as_ref(&self) -> &Self

Performs the conversion.

impl<R: Rosy> AsRef<AnyObject> for RosyObject<R>

fn as_ref(&self) -> &AnyObject

Performs the conversion.

impl AsRef<AnyObject> for Encoding

fn as_ref(&self) -> &AnyObject

Performs the conversion.

impl AsRef<AnyObject> for String

fn as_ref(&self) -> &AnyObject

Performs the conversion.

impl AsRef<AnyObject> for Symbol

fn as_ref(&self) -> &AnyObject

Performs the conversion.

impl AsRef<AnyObject> for InstrSeq

fn as_ref(&self) -> &AnyObject

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<O: Object> From<Array<O>> for AnyObject

fn from(object: Array<O>) -> AnyObject

Performs the conversion.

impl From<AnyException> for AnyObject

fn from(obj: AnyException) -> Self

Performs the conversion.

impl<K: Object, V: Object> From<Hash<K, V>> for AnyObject

fn from(object: Hash<K, V>) -> AnyObject

Performs the conversion.

impl From<Integer> for AnyObject

fn from(obj: Integer) -> Self

Performs the conversion.

impl From<usize> for AnyObject

fn from(int: usize) -> Self

Performs the conversion.

impl From<u128> for AnyObject

fn from(int: u128) -> Self

Performs the conversion.

impl From<u64> for AnyObject

fn from(int: u64) -> Self

Performs the conversion.

impl From<u32> for AnyObject

fn from(int: u32) -> Self

Performs the conversion.

impl From<u16> for AnyObject

fn from(int: u16) -> Self

Performs the conversion.

impl From<u8> for AnyObject

fn from(int: u8) -> Self

Performs the conversion.

impl From<isize> for AnyObject

fn from(int: isize) -> Self

Performs the conversion.

impl From<i128> for AnyObject

fn from(int: i128) -> Self

Performs the conversion.

impl From<i64> for AnyObject

fn from(int: i64) -> Self

Performs the conversion.

impl From<i32> for AnyObject

fn from(int: i32) -> Self

Performs the conversion.

impl From<i16> for AnyObject

fn from(int: i16) -> Self

Performs the conversion.

impl From<i8> for AnyObject

fn from(int: i8) -> Self

Performs the conversion.

impl From<Class> for AnyObject

fn from(object: Class) -> AnyObject

Performs the conversion.

impl From<Module> for AnyObject

fn from(object: Module) -> AnyObject

Performs the conversion.

impl<O: Into<AnyObject>> From<Option<O>> for AnyObject

fn from(option: Option<O>) -> Self

Performs the conversion.

impl<O: Into<AnyObject>, E: Into<AnyObject>> From<Result<O, E>> for AnyObject

fn from(result: Result<O, E>) -> Self

Performs the conversion.

impl From<f32> for AnyObject

fn from(f: f32) -> Self

Performs the conversion.

impl From<f64> for AnyObject

fn from(f: f64) -> Self

Performs the conversion.

impl From<bool> for AnyObject

fn from(b: bool) -> Self

Performs the conversion.

impl<R: Rosy> From<RosyObject<R>> for AnyObject

fn from(obj: RosyObject<R>) -> Self

Performs the conversion.

impl From<Encoding> for AnyObject

fn from(object: Encoding) -> AnyObject

Performs the conversion.

impl From<String> for AnyObject

fn from(object: String) -> AnyObject

Performs the conversion.

impl<'_> From<&'_ str> for AnyObject

fn from(string: &str) -> Self

Performs the conversion.

impl<'_> From<&'_ String> for AnyObject

fn from(string: &String) -> Self

Performs the conversion.

impl<'_> From<&'_ [u8]> for AnyObject

fn from(string: &[u8]) -> Self

Performs the conversion.

impl<'_> From<&'_ Vec<u8>> for AnyObject

fn from(string: &Vec<u8>) -> Self

Performs the conversion.

impl<'_> From<&'_ CStr> for AnyObject

fn from(string: &CStr) -> Self

Performs the conversion.

impl<'_> From<&'_ CString> for AnyObject

fn from(string: &CString) -> Self

Performs the conversion.

impl From<Symbol> for AnyObject

fn from(object: Symbol) -> AnyObject

Performs the conversion.

impl From<InstrSeq> for AnyObject

fn from(obj: InstrSeq) -> Self

Performs the conversion.

impl Eq for AnyObject

impl Copy for AnyObject

impl<O: Object> PartialEq<AnyObject> for Array<O>

fn eq(&self, obj: &AnyObject) -> 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<K: Object, V: Object> PartialEq<AnyObject> for Hash<K, V>

fn eq(&self, obj: &AnyObject) -> 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<O: Object> PartialEq<O> for AnyObject

fn eq(&self, other: &O) -> 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 PartialEq<[u8]> for AnyObject

fn eq(&self, other: &[u8]) -> 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<'_> PartialEq<&'_ [u8]> for AnyObject

fn eq(&self, other: &&[u8]) -> 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 PartialEq<AnyObject> for [u8]

fn eq(&self, obj: &AnyObject) -> 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<'_> PartialEq<AnyObject> for &'_ [u8]

fn eq(&self, obj: &AnyObject) -> 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 PartialEq<Vec<u8>> for AnyObject

fn eq(&self, other: &Vec<u8>) -> 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<'_> PartialEq<&'_ Vec<u8>> for AnyObject

fn eq(&self, other: &&Vec<u8>) -> 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 PartialEq<AnyObject> for Vec<u8>

fn eq(&self, obj: &AnyObject) -> 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<'_> PartialEq<AnyObject> for &'_ Vec<u8>

fn eq(&self, obj: &AnyObject) -> 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 PartialEq<str> for AnyObject

fn eq(&self, other: &str) -> 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<'_> PartialEq<&'_ str> for AnyObject

fn eq(&self, other: &&str) -> 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 PartialEq<AnyObject> for str

fn eq(&self, obj: &AnyObject) -> 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<'_> PartialEq<AnyObject> for &'_ str

fn eq(&self, obj: &AnyObject) -> 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 PartialEq<String> for AnyObject

fn eq(&self, other: &String) -> 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<'_> PartialEq<&'_ String> for AnyObject

fn eq(&self, other: &&String) -> 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 PartialEq<AnyObject> for String

fn eq(&self, obj: &AnyObject) -> 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<'_> PartialEq<AnyObject> for &'_ String

fn eq(&self, obj: &AnyObject) -> 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 PartialEq<CStr> for AnyObject

fn eq(&self, other: &CStr) -> 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<'_> PartialEq<&'_ CStr> for AnyObject

fn eq(&self, other: &&CStr) -> 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 PartialEq<AnyObject> for CStr

fn eq(&self, obj: &AnyObject) -> 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<'_> PartialEq<AnyObject> for &'_ CStr

fn eq(&self, obj: &AnyObject) -> 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 PartialEq<CString> for AnyObject

fn eq(&self, other: &CString) -> 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<'_> PartialEq<&'_ CString> for AnyObject

fn eq(&self, other: &&CString) -> 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 PartialEq<AnyObject> for CString

fn eq(&self, obj: &AnyObject) -> 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<'_> PartialEq<AnyObject> for &'_ CString

fn eq(&self, obj: &AnyObject) -> 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 PartialEq<bool> for AnyObject

fn eq(&self, other: &bool) -> 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<'_> PartialEq<&'_ bool> for AnyObject

fn eq(&self, other: &&bool) -> 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 PartialEq<AnyObject> for bool

fn eq(&self, obj: &AnyObject) -> 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<'_> PartialEq<AnyObject> for &'_ bool

fn eq(&self, obj: &AnyObject) -> 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<R: Rosy> PartialEq<AnyObject> for RosyObject<R>

fn eq(&self, obj: &AnyObject) -> 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 PartialEq<AnyObject> for Encoding

fn eq(&self, obj: &AnyObject) -> 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 PartialEq<AnyObject> for Symbol

fn eq(&self, obj: &AnyObject) -> 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 PartialEq<AnyObject> for InstrSeq

fn eq(&self, obj: &AnyObject) -> 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 Debug for AnyObject

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

Formats the value using the given formatter.

impl Display for AnyObject

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

Formats the value using the given formatter.