Struct rosy::RosyObject

#[repr(transparent)]
pub struct RosyObject<R> { /* fields omitted */ }

An instance of a Ruby object that wraps around Rust data.

See the documentation for Rosy for more information.

Methods

impl<R: Rosy> RosyObject<R>

pub fn as_data(&self) -> &R

Returns a reference to the inner Rosy value.

Trait Implementations

impl<R: Rosy> Object for RosyObject<R>

fn unique_id() -> Option<u128>

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

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

Attempts to create an instance by casting obj.

fn class(self) -> Class<Self>

Returns the Class for self.

unsafe fn from_raw(raw: usize) -> Self

Creates a new object from raw without checking.

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

Casts obj to Self without checking its type.

fn into_any_object(self) -> AnyObject

Returns self as an AnyObject.

fn as_any_object(&self) -> &AnyObject

Returns a reference to self as an AnyObject.

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

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

fn raw(self) -> usize

Returns the raw object pointer.

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 ty(self) -> Ty

Returns the virtual type of self.

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

Returns whether the virtual type of self is ty.

fn singleton_class(self) -> Class<Self>

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<Self>, 

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<Self>, 

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

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

Calls method on self and returns its output.

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

Calls method on self and returns its output, or an exception if one is raised.

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

Calls method on self with args and returns its output.

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

Calls method on self with args and returns its output, or an exception if one is raised.

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

Calls the public method on self and returns its output.

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

Calls the public method on self and returns its output, or an exception if one is raised.

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

Calls the public method on self with args and returns its output.

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

Calls the public method on self with args and returns its output, or an exception if one is raised.

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.

fn get_attr<N: Into<SymbolId>>(self, name: N) -> AnyObject

Returns the value for the attribute of self associated with name.

unsafe fn eval(self, args: impl EvalArgs) -> AnyObject

Evaluates args in the context of self.

unsafe fn eval_protected(self, args: impl EvalArgs) -> Result<AnyObject>

Evaluates args in the context of self, returning any raised exceptions.

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<R> Copy for RosyObject<R>

impl<R> Clone for RosyObject<R>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

fn as_ref(&self) -> &AnyObject

Performs the conversion.

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

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

Performs the conversion.

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

fn from(rosy: Box<R>) -> Self

Performs the conversion.

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

fn from(rosy: R) -> Self

Performs the conversion.

impl<R: Rosy> Debug for RosyObject<R>

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

Formats the value using the given formatter.

impl<R: Rosy> Display for RosyObject<R>

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

Formats the value using the given formatter.