pub struct Skeleton { /* private fields */ }Expand description
The entire skeleton, storing a list of nodes plus an optional root_id.
Implementations§
Source§impl Skeleton
impl Skeleton
Sourcepub fn set_target_name(&mut self, val: String) -> &mut Self
pub fn set_target_name(&mut self, val: String) -> &mut Self
This field holds verbatim the lower-kebab-case target-name belonging to the tree grow process.
Sourcepub fn set_nodes(&mut self, val: Vec<SkeletonNode>) -> &mut Self
pub fn set_nodes(&mut self, val: Vec<SkeletonNode>) -> &mut Self
The nodes in this skeleton
Sourcepub fn set_root_id(&mut self, val: Option<u16>) -> &mut Self
pub fn set_root_id(&mut self, val: Option<u16>) -> &mut Self
The root node’s ID, if any
Source§impl Skeleton
impl Skeleton
Sourcepub fn target_name_mut(&mut self) -> &mut String
pub fn target_name_mut(&mut self) -> &mut String
This field holds verbatim the lower-kebab-case target-name belonging to the tree grow process.
Sourcepub fn nodes_mut(&mut self) -> &mut Vec<SkeletonNode>
pub fn nodes_mut(&mut self) -> &mut Vec<SkeletonNode>
The nodes in this skeleton
Sourcepub fn root_id_mut(&mut self) -> &mut Option<u16>
pub fn root_id_mut(&mut self) -> &mut Option<u16>
The root node’s ID, if any
Source§impl Skeleton
impl Skeleton
pub fn from_toml_file<P: AsRef<Path>>(path: P) -> Result<Self, SkeletonError>
pub fn to_toml_file<P: AsRef<Path>>(&self, path: P) -> Result<(), SkeletonError>
pub fn node_count(&self) -> usize
pub fn root_node(&self) -> Option<&SkeletonNode>
Trait Implementations§
Source§impl<'de> Deserialize<'de> for Skeleton
impl<'de> Deserialize<'de> for Skeleton
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl TreeBalanceSymmetryMeasurer for Skeleton
impl TreeBalanceSymmetryMeasurer for Skeleton
Source§fn measure_tree_balance_symmetry(&self) -> Option<f32>
fn measure_tree_balance_symmetry(&self) -> Option<f32>
Source§impl TreeBreadthMeasurer for Skeleton
impl TreeBreadthMeasurer for Skeleton
Source§impl TreeDensityMeasurer for Skeleton
impl TreeDensityMeasurer for Skeleton
Source§fn measure_tree_density_distribution(&self) -> Vec<u16>
fn measure_tree_density_distribution(&self) -> Vec<u16>
Source§impl TreeDepthMeasurer for Skeleton
impl TreeDepthMeasurer for Skeleton
Source§fn measure_tree_depth(&self) -> u8
fn measure_tree_depth(&self) -> u8
Source§impl TreeLeafGranularityMeasurer for Skeleton
impl TreeLeafGranularityMeasurer for Skeleton
Source§fn measure_tree_leaf_granularity(&self) -> Option<f32>
fn measure_tree_leaf_granularity(&self) -> Option<f32>
Source§impl TreeLevelSkippingMeasurer for Skeleton
impl TreeLevelSkippingMeasurer for Skeleton
Source§fn measure_tree_level_skipping(&self) -> HashMap<u8, TreeLevelSkippingStats>
fn measure_tree_level_skipping(&self) -> HashMap<u8, TreeLevelSkippingStats>
Source§impl TreeLevelSpecificMeasurer for Skeleton
impl TreeLevelSpecificMeasurer for Skeleton
Source§fn measure_tree_level_stats(&self) -> HashMap<u8, TreeLevelAggregate>
fn measure_tree_level_stats(&self) -> HashMap<u8, TreeLevelAggregate>
Source§impl TreeSubBranchOrderingMeasurer for Skeleton
impl TreeSubBranchOrderingMeasurer for Skeleton
Source§fn measure_tree_sub_branch_orderings(&self) -> Vec<SubBranchOrdering>
fn measure_tree_sub_branch_orderings(&self) -> Vec<SubBranchOrdering>
impl StructuralPartialEq for Skeleton
Auto Trait Implementations§
impl Freeze for Skeleton
impl RefUnwindSafe for Skeleton
impl Send for Skeleton
impl Sync for Skeleton
impl Unpin for Skeleton
impl UnwindSafe for Skeleton
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoCollection<T> for T
impl<T> IntoCollection<T> for T
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);