Struct oop_inheritance::Node

pub struct Node { /* private fields */ }

Represents an node as a type managed by reference-counting.

Implementations

impl Node

pub fn new() -> Node

pub fn downgrade_ref(&self) -> WeakNodeRef

Downgrades the node reference into a weak reference.

pub fn has<T>(&self) -> bool

where T: Any + Send + Sync,

Checks whether node has a specified component.

pub fn get<T>(&self) -> Option<Arc<T>>

where T: Any + Send + Sync,

Retrieves a component from the node.

pub fn set<T>(&self, value: T) -> Self

where T: Any + Send + Sync,

Overrides a component of the node. This method is chainable.

pub fn delete<T>(&self) -> bool

where T: Any + Send + Sync,

Deletes a component of the node. Returns true if any component was deleted; otherwise returns false.

pub fn parent(&self) -> Option<Node>

pub fn children(&self) -> Vec<Node>

pub fn child_at(&self, index: usize) -> Option<Node>

pub fn num_children(&self) -> usize

Returns the number of children.

pub fn add_child(&self, child: impl AsRef<Node>)

Adds a child node to the end of the children collection. If child is already child of an node, it is removed and then added as part of this node.

pub fn add_child_at(&self, index: usize, child: impl AsRef<Node>)

Adds a child node at the index index of the children collection. If child is already child of an node, it is removed and then added as part of this node.

Panics

This method panics if index is out of bounds.

pub fn add_children(&self, children: impl IntoIterator<Item = impl AsRef<Node>>)

Adds a sequence of children to the end of the children collection. This is equivalent to iterating the sequence and invoking add_child() with every child.

pub fn swap_children( &self, child_1: impl AsRef<Node>, child_2: impl AsRef<Node> )

Swaps two children.

Panics

Panics if any of the specified nodes is not part of the node.

pub fn swap_children_by_indices(&self, child_1: usize, child_2: usize)

Swaps two children.

Panics

Panics if any of the specified indices is out of bounds.

pub fn remove_child(&self, child: impl AsRef<Node>) -> bool

Removes a child. Returns true if the child has been removed, or false otherwise.

pub fn remove_children(&self)

Removes all children nodes from the node.

pub fn remove_from_parent(&self) -> bool

Removes the node from its parent. Returns true if the child has been removed, or false otherwise.

pub fn name(&self) -> Option<String>

The name of the node as used in Node paths.

pub fn set_name(&self, name: Option<String>)

The name of the node as used in Node paths.

pub fn resolve_path(&self, path: &str) -> Option<Node>

Resolves an Node path. An Node path is resolved as follows:

1. Let segments be the splitting of the path by the slash character (/).
2. Let r be the initial node.
3. For every segment s:
   1. If s == ".first", let r be the first child of r or otherwise None.
   2. If s == ".last", let r be the last child of r or otherwise None.
   3. If s == "..", let r be the parent of r or otherwise None.
   4. If s is non-empty, let r be a child of r such that child.name() == s or otherwise None.
4. Return r

pub fn is<T: TryFrom<Self, Error = ClassError>>(&self) -> bool

Indicates whether an Node is of a certain Node subtype.

pub fn to<T: TryFrom<Self, Error = ClassError>>(&self) -> Result<T, ClassError>

Attempts to convert this Node reference into a T reference.

Trait Implementations

impl AsRef<Node> for Node

fn as_ref(&self) -> &Node

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Node

fn clone(&self) -> Self

Clones the node by reference.

Note: This method does not clone the node by content.

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

Performs copy-assignment from source.

impl Debug for Node

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

Formats the value using the given formatter.

impl Hash for Node

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

Hashes the node by reference.

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 PartialEq for Node

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

Compares nodes by reference.

Note: This method does not compare the nodes by content.

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 Eq for Node