Struct bones_framework::prelude::piccolo::UserData

pub struct UserData<'gc>(/* private fields */);

Implementations

impl<'gc> UserData<'gc>

pub fn new<R>( mc: &Mutation<'gc>, val: <R as Rootable<'gc>>::Root, ) -> UserData<'gc>

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

pub fn new_static<R>(mc: &Mutation<'gc>, val: R) -> UserData<'gc>

where R: 'static,

pub fn from_inner( inner: Gc<'gc, AnyInner<Lock<UserDataMeta<'gc>>>>, ) -> UserData<'gc>

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

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

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

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

where R: 'static,

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

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

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

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

pub fn downcast_static<R>(self) -> Result<&'gc R, BadUserDataType>

where R: 'static,

pub fn metatable(self) -> Option<Table<'gc>>

pub fn set_metatable( self, mc: &Mutation<'gc>, metatable: Option<Table<'gc>>, ) -> Option<Table<'gc>>

Trait Implementations

impl<'gc> Clone for UserData<'gc>

fn clone(&self) -> UserData<'gc>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'gc> Collect for UserData<'gc>

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> Debug for UserData<'gc>

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

Formats the value using the given formatter.

impl<'gc> From<UserData<'gc>> for Value<'gc>

fn from(v: UserData<'gc>) -> Value<'gc>

Converts to this type from the input type.

impl<'gc> FromValue<'gc> for UserData<'gc>

fn from_value( _: Context<'gc>, value: Value<'gc>, ) -> Result<UserData<'gc>, TypeError>

impl<'gc> Hash for UserData<'gc>

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<'a, 'gc> IntoValue<'gc> for &'a UserData<'gc>

fn into_value(self, ctx: Context<'gc>) -> Value<'gc>

impl<'gc> IntoValue<'gc> for UserData<'gc>

fn into_value(self, _: Context<'gc>) -> Value<'gc>

impl<'gc> PartialEq for UserData<'gc>

fn eq(&self, other: &UserData<'gc>) -> 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> Stashable<'gc> for UserData<'gc>

type Stashed = StashedUserData

fn stash( self, roots: &DynamicRootSet<'gc>, mc: &Mutation<'gc>, ) -> <UserData<'gc> as Stashable<'gc>>::Stashed

impl<'gc> Copy for UserData<'gc>

impl<'gc> Eq for UserData<'gc>