pub struct CapstoneGenerationConfiguration { /* private fields */ }Expand description
In the context of our tree-generation system, a capstone node is a special type of leaf node that represents a culminating skill, concept, or endpoint of a hierarchical branch.
Capstone nodes stand out clearly as a final, specialized mastery points—often signifying an advanced, important, or unique skill within a skill-tree.
Capstone nodes act as distinctive markers, clearly communicating to users that this particular node is either:
- Essential: representing the core or pinnacle achievement of a skill branch.
- Prestigious: indicating a high-level mastery or rare skill.
- Strategic: highlighting a concept that offers substantial practical or conceptual leverage.
This struct merges the chosen capstone mode with its relevant probability (if any).
Implementations§
Source§impl CapstoneGenerationConfiguration
impl CapstoneGenerationConfiguration
Sourcepub fn mode(&self) -> &CapstoneMode
pub fn mode(&self) -> &CapstoneMode
This field should be one of Off, Single, or Probabilistic.
Sourcepub fn probability(&self) -> &f32
pub fn probability(&self) -> &f32
This fraction [0..1] is only meaningful if mode=Probabilistic, specifying
which fraction of leaves become highlight/capstones.
Source§impl CapstoneGenerationConfiguration
impl CapstoneGenerationConfiguration
pub fn validate(&self) -> Result<(), GrowerTreeConfigurationError>
Trait Implementations§
Source§impl AiJsonTemplate for CapstoneGenerationConfiguration
impl AiJsonTemplate for CapstoneGenerationConfiguration
Source§fn to_template() -> Value
fn to_template() -> Value
Source§impl Clone for CapstoneGenerationConfiguration
impl Clone for CapstoneGenerationConfiguration
Source§fn clone(&self) -> CapstoneGenerationConfiguration
fn clone(&self) -> CapstoneGenerationConfiguration
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Default for CapstoneGenerationConfiguration
impl Default for CapstoneGenerationConfiguration
Source§fn default() -> CapstoneGenerationConfiguration
fn default() -> CapstoneGenerationConfiguration
Source§impl<'de> Deserialize<'de> for CapstoneGenerationConfiguration
impl<'de> Deserialize<'de> for CapstoneGenerationConfiguration
Source§fn deserialize<__D>(
__deserializer: __D,
) -> Result<CapstoneGenerationConfiguration, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<CapstoneGenerationConfiguration, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
Source§impl From<JustifiedCapstoneGenerationConfiguration> for CapstoneGenerationConfiguration
impl From<JustifiedCapstoneGenerationConfiguration> for CapstoneGenerationConfiguration
Source§fn from(
value: JustifiedCapstoneGenerationConfiguration,
) -> CapstoneGenerationConfiguration
fn from( value: JustifiedCapstoneGenerationConfiguration, ) -> CapstoneGenerationConfiguration
Source§impl LoadFromFile for CapstoneGenerationConfigurationwhere
CapstoneGenerationConfiguration: for<'de> Deserialize<'de>,
impl LoadFromFile for CapstoneGenerationConfigurationwhere
CapstoneGenerationConfiguration: for<'de> Deserialize<'de>,
type Error = SaveLoadError
fn load_from_file<'async_trait>(
filename: impl AsRef<Path> + Send + 'async_trait,
) -> Pin<Box<dyn Future<Output = Result<CapstoneGenerationConfiguration, <CapstoneGenerationConfiguration as LoadFromFile>::Error>> + Send + 'async_trait>>where
CapstoneGenerationConfiguration: 'async_trait,
Source§impl PartialEq for CapstoneGenerationConfiguration
impl PartialEq for CapstoneGenerationConfiguration
Source§fn eq(&self, other: &CapstoneGenerationConfiguration) -> bool
fn eq(&self, other: &CapstoneGenerationConfiguration) -> bool
self and other values to be equal, and is used by ==.Source§impl SaveToFile for CapstoneGenerationConfiguration
impl SaveToFile for CapstoneGenerationConfiguration
type Error = SaveLoadError
fn save_to_file<'life0, 'async_trait>(
&'life0 self,
filename: impl AsRef<Path> + Send + 'async_trait,
) -> Pin<Box<dyn Future<Output = Result<(), <CapstoneGenerationConfiguration as SaveToFile>::Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
CapstoneGenerationConfiguration: 'async_trait,
Source§impl Serialize for CapstoneGenerationConfiguration
impl Serialize for CapstoneGenerationConfiguration
Source§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
impl StructuralPartialEq for CapstoneGenerationConfiguration
Auto Trait Implementations§
impl Freeze for CapstoneGenerationConfiguration
impl RefUnwindSafe for CapstoneGenerationConfiguration
impl Send for CapstoneGenerationConfiguration
impl Sync for CapstoneGenerationConfiguration
impl Unpin for CapstoneGenerationConfiguration
impl UnwindSafe for CapstoneGenerationConfiguration
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> LoadFromDirectory for Twhere
T: LoadFromFile + Send,
<T as LoadFromFile>::Error: Display + From<SaveLoadError> + From<Error> + Send + 'static,
impl<T> LoadFromDirectory for Twhere
T: LoadFromFile + Send,
<T as LoadFromFile>::Error: Display + From<SaveLoadError> + From<Error> + Send + 'static,
Source§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);