[−][src]Trait rosy::Object

pub unsafe trait Object: Copy + Into<AnyObject> + AsRef<AnyObject> + PartialEq<AnyObject> + Debug {
    fn unique_id() -> Option<u128> { ... }
    unsafe fn from_raw(raw: usize) -> Self { ... }
    fn cast<A: Object>(obj: A) -> Option<Self> { ... }
    unsafe fn cast_unchecked(obj: impl Object) -> Self { ... }
    fn into_any_object(self) -> AnyObject { ... }
    fn as_any_object(&self) -> &AnyObject { ... }
    fn as_any_slice(&self) -> &[AnyObject] { ... }
    fn raw(self) -> usize { ... }
    unsafe fn as_unchecked<O: Object>(&self) -> &O { ... }
    unsafe fn into_unchecked<O: Object>(self) -> O { ... }
    fn id(self) -> u64 { ... }
    fn ty(self) -> Ty { ... }
    fn is_ty(self, ty: Ty) -> bool { ... }
    fn class(self) -> Class<Self> { ... }
    fn singleton_class(self) -> Class<Self> { ... }
    fn mark(self) { ... }
    unsafe fn force_recycle(self) { ... }
    fn def_singleton_method<N, F>(self, name: N, f: F) -> Result
    where
        N: Into<SymbolId>,
        F: MethodFn<Self>,
    { ... }
    unsafe fn def_singleton_method_unchecked<N, F>(self, name: N, f: F)
    where
        N: Into<SymbolId>,
        F: MethodFn<Self>,
    { ... }
    unsafe fn call(self, method: impl Into<SymbolId>) -> AnyObject { ... }
    unsafe fn call_protected(
        self, 
        method: impl Into<SymbolId>
    ) -> Result<AnyObject> { ... }
    unsafe fn call_with(
        self, 
        method: impl Into<SymbolId>, 
        args: &[impl Object]
    ) -> AnyObject { ... }
    unsafe fn call_with_protected(
        self, 
        method: impl Into<SymbolId>, 
        args: &[impl Object]
    ) -> Result<AnyObject> { ... }
    unsafe fn call_public(self, method: impl Into<SymbolId>) -> AnyObject { ... }
    unsafe fn call_public_protected(
        self, 
        method: impl Into<SymbolId>
    ) -> Result<AnyObject> { ... }
    unsafe fn call_public_with(
        self, 
        method: impl Into<SymbolId>, 
        args: &[impl Object]
    ) -> AnyObject { ... }
    unsafe fn call_public_with_protected(
        self, 
        method: impl Into<SymbolId>, 
        args: &[impl Object]
    ) -> Result<AnyObject> { ... }
    fn inspect(self) -> String { ... }
    fn to_s(self) -> String { ... }
    fn is_frozen(self) -> bool { ... }
    fn freeze(self) { ... }
    fn is_eql<O: Object>(self, other: &O) -> bool { ... }
    fn get_attr<N: Into<SymbolId>>(self, name: N) -> AnyObject { ... }
    unsafe fn eval(self, args: impl EvalArgs) -> AnyObject { ... }
    unsafe fn eval_protected(self, args: impl EvalArgs) -> Result<AnyObject> { ... }
}

Some concrete Ruby object.

Safety

All types that implement this trait must be light wrappers around an AnyObject and thus have the same size and layout.

Provided methods

`fn unique_id() -> Option<u128>`

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

Safety

This value must be unique. Rosy's built-in objects use identifiers that are very close to u128::max_value(), so those are easy to avoid.

`unsafe fn from_raw(raw: usize) -> Self`

Creates a new object from raw without checking.

Safety

The following invariants must be upheld:

The value came from the Ruby VM
The value is a valid representation of Self

Not following this will lead to nasal demons. You've been warned.

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

Attempts to create an instance by casting obj.

The default implementation checks the unique_id of A against that of Self.

`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 class(self) -> Class<Self>`

Returns the Class for self.

Note that if Self implements Classify, Self::class() may not be equal to the result of this method.

`fn singleton_class(self) -> Class<Self>`

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

Note that Class::new_instance does not work on singleton classes due to the class being attached to the specific object instance for self.

`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.

Safety

The caller must ensure that self does not have ownership over any currently-referenced memory.

`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.

Safety

The caller must ensure that self is not frozen or else a FrozenError exception will be raised.