Struct rbx_dom_weak::RbxTree

pub struct RbxTree { /* fields omitted */ }

Represents a tree containing Roblox instances.

Instances are described by RbxInstance objects and have an ID, children, and a parent.

When constructing instances, you'll want to create RbxInstanceProperties objects and insert them into the tree.

Methods

impl RbxTree

pub fn new(root_properties: RbxInstanceProperties) -> RbxTree

Construct a new RbxTree with its root instance constructed using the given properties.

pub fn get_root_id(&self) -> RbxId

Returns the ID of the root instance in the tree, which can be used alongside get_instance and friends.

pub fn iter_all_ids(&self) -> impl Iterator<Item = RbxId> + '_

Returns an iterator over all IDs in the tree.

pub fn get_instance(&self, id: RbxId) -> Option<&RbxInstance>

Returns the instance with the given ID if it's contained in this tree.

pub fn get_instance_mut(&mut self, id: RbxId) -> Option<&mut RbxInstance>

Returns mutable access to the instance with the given ID if it's contained in this tree.

pub fn move_instance(
    &mut self,
    source_id: RbxId,
    dest_tree: &mut RbxTree,
    dest_parent_id: RbxId
)

Move the instance with the given ID from this tree to a new tree, underneath the given parent instance ID.

Panics

Panics if the instance source_id doesn't exist in the source tree or if the instance dest_parent_id doesn't exist in the destination tree.

pub fn set_parent(&mut self, id: RbxId, dest_parent_id: RbxId)

Move the instance with the ID id so that its new parent is dest_parent_id.

Panics

Panics if id or dest_parent_id do not refer to instances that exist in the tree.

Panics if this operation would cause the tree to become cyclical and invalid.

pub fn insert_instance(
    &mut self,
    properties: RbxInstanceProperties,
    parent_id: RbxId
) -> RbxId

Inserts a new instance with the given properties into the tree, putting it under the instance with the given ID.

Panics

Panics if the given ID does not refer to an instance in this tree.

pub fn remove_instance(&mut self, root_id: RbxId) -> Option<RbxTree>

Given an ID, remove the instance from the tree with that ID, along with all of its descendants.

Important traits for Descendants<'a>

impl<'a> Iterator for Descendants<'a> type Item = &'a RbxInstance;

pub fn descendants(&self, id: RbxId) -> Descendants

Returns an iterator over all of the descendants of the given instance by ID.

Panics

Panics if the given ID is not present in the tree.

Trait Implementations

impl Clone for RbxTree

fn clone(&self) -> RbxTree

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RbxTree

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RbxTree

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<RbxTree> for RbxTree

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

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

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

This method tests for !=.

impl Serialize for RbxTree

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 RbxTree