Struct bones_framework::prelude::piccolo::any::Any

pub struct Any<'gc, M = ()>(/* private fields */)
where
    M: 'gc;

A Gc pointer to any type T: Collect + 'gc which allows safe downcasting.

The optional M metadata parameter provides a way of including statically typed metadata along with the dynamically typed value.

Implementations

impl<'gc, M> Any<'gc, M>

pub fn new<R>( mc: &Mutation<'gc>, data: <R as Rootable<'gc>>::Root, ) -> Any<'gc, M>

where M: Collect + Default, R: for<'a> Rootable<'a>,

pub fn with_metadata<R>( mc: &Mutation<'gc>, metadata: M, data: <R as Rootable<'gc>>::Root, ) -> Any<'gc, M>

where M: Collect, R: for<'a> Rootable<'a>,

pub fn from_inner(inner: Gc<'gc, AnyInner<M>>) -> Any<'gc, M>

pub fn into_inner(self) -> Gc<'gc, AnyInner<M>>

pub fn metadata(self) -> &'gc M

pub fn write_metadata(self, mc: &Mutation<'gc>) -> &'gc Write<M>

pub fn type_id(self) -> TypeId

pub fn is<R>(self) -> bool

where R: for<'b> Rootable<'b>,

pub fn downcast<R>(self) -> Option<&'gc <R as Rootable<'gc>>::Root>

where R: for<'b> Rootable<'b>,

pub fn downcast_write<R>( self, mc: &Mutation<'gc>, ) -> Option<&'gc Write<<R as Rootable<'gc>>::Root>>

where R: for<'b> Rootable<'b>,

Trait Implementations

impl<'gc, M> Clone for Any<'gc, M>

fn clone(&self) -> Any<'gc, M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'gc, M> Collect for Any<'gc, M>

where M: 'gc + Collect,

fn needs_trace() -> bool

As an optimization, if this type can never hold a Gc pointer and trace is unnecessary to call, you may implement this method and return false. The default implementation returns true, signaling that Collect::trace must be called.

fn trace(&self, cc: &Collection)

Must call Collect::trace on all held Gc pointers. If this type holds inner types that implement Collect, a valid implementation would simply call Collect::trace on all the held values to ensure this.

impl<'gc, M> Debug for Any<'gc, M>

where M: Debug,

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'gc, M> Hash for Any<'gc, M>

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'gc, M> PartialEq for Any<'gc, M>

fn eq(&self, other: &Any<'gc, M>) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'gc, M> Copy for Any<'gc, M>

impl<'gc, M> Eq for Any<'gc, M>