Struct RbxTree

pub struct RbxTree { /* private fields */ }

Represents a tree containing rooted instances.

Rooted instances are described by RbxInstance and have an ID, children, and a parent.

Implementations

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

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

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

Trait Implementations

impl Clone for RbxTree

fn clone(&self) -> RbxTree

Returns a duplicate 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 for RbxTree

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

Tests for self and other values to be equal, and is used by ==.

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

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

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