Struct prodash::progress::Key

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

A type identifying a spot in the hierarchy of Tree items.

Implementations

impl Key

pub fn add_child(self, child_id: u16) -> Key

Return the key to the child identified by child_id located in a new nesting level below self.

pub fn level(&self) -> Level

The level of hierarchy a node is placed in, i.e. the amount of path components

pub fn shares_parent_with(&self, other: &Key, parent_level: Level) -> bool

Return true if the item identified by other shares the parent at parent_level.

pub fn adjacency(sorted: &[(Key, Task)], index: usize) -> Adjacency

Compute the adjacency map for the key in sorted at the given index.

It’s vital that the invariant of sorted to actually be sorted by key is upheld for the result to be reliable.

pub const fn max_level() -> Level

The maximum amount of path components we can represent.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl Default for Key

fn default() -> Key

Returns the “default value” for a type.

impl Hash for Key

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 Index<u8> for Key

type Output = u16

The returned type after indexing.

fn index(&self, index: Level) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Ord for Key

fn cmp(&self, other: &Key) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Key

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

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

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 PartialOrd for Key

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Key

impl Eq for Key

impl StructuralEq for Key

impl StructuralPartialEq for Key