Struct NodeId 

pub struct NodeId(/* private fields */);

A node’s place in the plan, as the first column spells it: 2, 2.3, 2.3.1. The parent is the prefix, so the tree needs no second field to say where a node hangs.

Ordering is the reading order of the table — 1, 1.1, 1.2, 2 — because segment-wise comparison is exactly that order.

Implementations

impl NodeId

pub fn parse(raw: &str) -> Result<NodeId, AxError>

Reads an index cell.

Errors

Refuses an empty cell, a segment that is not a number, a zero segment (the table is one-based, and 0 next to 1 reads as a different node than it is), a leading zero (01 and 1 would be two spellings of one node), and a branch deeper than NODE_DEPTH_MAX.

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

The node this one hangs under, or None for a top-level node.

pub fn ordinal(&self) -> u32

The last segment: which child of its parent this is.

pub fn depth(&self) -> usize

How many levels down this node sits; a top-level node is 1.

pub fn is_ancestor_of(&self, other: &NodeId) -> bool

Whether other hangs below this node, at any depth. A node is not its own ancestor.

pub fn ancestors(&self) -> Vec<NodeId>

Every node between the root and this one, closest last.

pub fn child(&self, ordinal: u32) -> Result<NodeId, AxError>

This node’s n-th child.

Errors

Refuses an ordinal of zero and a child past NODE_DEPTH_MAX.

pub fn as_str(&self) -> &str

Trait Implementations

impl Clone for NodeId

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NodeId

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for NodeId

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

Formats the value using the given formatter.

impl Eq for NodeId

impl Hash for NodeId

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

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 Ord for NodeId

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for NodeId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for NodeId

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for NodeId

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 NodeId