Struct rbx_dom_weak::RbxInstance

pub struct RbxInstance { /* fields omitted */ }

Represents an instance that is rooted in an RbxTree. These are always returned from an existing RbxTree with a method like RbxTree::get_instance.

RbxInstance derefs to RbxInstanceProperties to make accessing properties easier.

Methods

impl RbxInstance

pub fn get_id(&self) -> RbxId

Returns the unique ID associated with this instance.

pub fn get_parent_id(&self) -> Option<RbxId>

Returns the ID of the parent of this instance, if it has a parent.

pub fn get_children_ids(&self) -> &[RbxId]

Returns a list of the IDs of the children of this instance.

pub fn sort_children_by_key<K, F>(&mut self, f: F) where
    F: FnMut(RbxId) -> K,
    K: Ord, 

Re-orders children using the given key function. This sort is stable.

Works the same as Vec::sort_by_key which is used internally.

pub fn sort_children_unstable_by_key<K, F>(&mut self, f: F) where
    F: FnMut(RbxId) -> K,
    K: Ord, 

Re-orders children using the given key function. This sort is unstable.

Works the same as Vec::sort_unstable_by_key which is used internally.

Trait Implementations

impl Clone for RbxInstance

fn clone(&self) -> RbxInstance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RbxInstance

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

Formats the value using the given formatter.

impl Deref for RbxInstance

type Target = RbxInstanceProperties

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for RbxInstance

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for RbxInstance

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<RbxInstance> for RbxInstance

fn eq(&self, other: &RbxInstance) -> bool

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

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

This method tests for !=.

impl Serialize for RbxInstance

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RbxInstance