pub struct CoreSkeletalDispatchNode { /* private fields */ }
Expand description
With the exception of generating the descriptor
field for this node, we source the fields
from the corresponding fields in StrippedStringSkeleton
.
Implementations§
Source§impl CoreSkeletalDispatchNode
impl CoreSkeletalDispatchNode
Sourcepub fn descriptor(&self) -> &String
pub fn descriptor(&self) -> &String
We generate this field by creating a concise textual note describing this node’s functional role within its domain.
§Descriptor Guidance
Each descriptor should be:
- Concise (1–2 short sentences).
- Domain-relevant and self-contained—no meta-references like “This is a node about…” or “In the data structure…”.
- Written so that when descriptors are read in a random top-down path from root to leaf, they form a coherent explanation or statement about a possible scenario or state.
- Each node’s descriptor stands alone yet supports a narrative when combined with its ancestors/descendants.
Sourcepub fn children(&self) -> &Vec<NamedChildSpec>
pub fn children(&self) -> &Vec<NamedChildSpec>
This field should be taken directly from the same field in StrippedStringSkeleton
Source§impl CoreSkeletalDispatchNode
impl CoreSkeletalDispatchNode
Sourcepub fn set_name(&mut self, val: String) -> &mut Self
pub fn set_name(&mut self, val: String) -> &mut Self
The node’s official UpperCamelCase identifier
Sourcepub fn set_descriptor(&mut self, val: String) -> &mut Self
pub fn set_descriptor(&mut self, val: String) -> &mut Self
We generate this field by creating a concise textual note describing this node’s functional role within its domain.
§Descriptor Guidance
Each descriptor should be:
- Concise (1–2 short sentences).
- Domain-relevant and self-contained—no meta-references like “This is a node about…” or “In the data structure…”.
- Written so that when descriptors are read in a random top-down path from root to leaf, they form a coherent explanation or statement about a possible scenario or state.
- Each node’s descriptor stands alone yet supports a narrative when combined with its ancestors/descendants.
Sourcepub fn set_children(&mut self, val: Vec<NamedChildSpec>) -> &mut Self
pub fn set_children(&mut self, val: Vec<NamedChildSpec>) -> &mut Self
This field should be taken directly from the same field in StrippedStringSkeleton
Trait Implementations§
Source§impl AiJsonTemplate for CoreSkeletalDispatchNode
impl AiJsonTemplate for CoreSkeletalDispatchNode
Source§fn to_template() -> Value
fn to_template() -> Value
Source§impl Clone for CoreSkeletalDispatchNode
impl Clone for CoreSkeletalDispatchNode
Source§fn clone(&self) -> CoreSkeletalDispatchNode
fn clone(&self) -> CoreSkeletalDispatchNode
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CoreSkeletalDispatchNode
impl Debug for CoreSkeletalDispatchNode
Source§impl<'de> Deserialize<'de> for CoreSkeletalDispatchNode
impl<'de> Deserialize<'de> for CoreSkeletalDispatchNode
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 Hash for CoreSkeletalDispatchNode
impl Hash for CoreSkeletalDispatchNode
Source§impl LoadFromFile for CoreSkeletalDispatchNodewhere
CoreSkeletalDispatchNode: for<'de> Deserialize<'de>,
impl LoadFromFile for CoreSkeletalDispatchNodewhere
CoreSkeletalDispatchNode: for<'de> Deserialize<'de>,
Source§impl PartialEq for CoreSkeletalDispatchNode
impl PartialEq for CoreSkeletalDispatchNode
Source§impl SaveToFile for CoreSkeletalDispatchNodewhere
CoreSkeletalDispatchNode: Serialize,
impl SaveToFile for CoreSkeletalDispatchNodewhere
CoreSkeletalDispatchNode: Serialize,
Source§impl Serialize for CoreSkeletalDispatchNode
impl Serialize for CoreSkeletalDispatchNode
impl Eq for CoreSkeletalDispatchNode
impl StructuralPartialEq for CoreSkeletalDispatchNode
Auto Trait Implementations§
impl Freeze for CoreSkeletalDispatchNode
impl RefUnwindSafe for CoreSkeletalDispatchNode
impl Send for CoreSkeletalDispatchNode
impl Sync for CoreSkeletalDispatchNode
impl Unpin for CoreSkeletalDispatchNode
impl UnwindSafe for CoreSkeletalDispatchNode
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<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
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);