Skip to main content

JustifiedGrowerTreeConfiguration

capability_skeleton_string

Struct JustifiedGrowerTreeConfiguration 

Source 
pub struct JustifiedGrowerTreeConfiguration { /* private fields */ }

Implementations§

Source§

impl JustifiedGrowerTreeConfiguration

Source

pub fn target_name(&self) -> &String

Source

pub fn target_name_confidence(&self) -> &f64

Source

pub fn target_name_justification(&self) -> &String

Source

pub fn depth(&self) -> &u8

Source

pub fn depth_confidence(&self) -> &f64

Source

pub fn depth_justification(&self) -> &String

Source

pub fn breadth(&self) -> &u8

Source

pub fn breadth_confidence(&self) -> &f64

Source

pub fn breadth_justification(&self) -> &String

Source

pub fn density(&self) -> &u8

Source

pub fn density_confidence(&self) -> &f64

Source

pub fn density_justification(&self) -> &String

Source

pub fn leaf_granularity(&self) -> &f32

Source

pub fn leaf_granularity_confidence(&self) -> &f64

Source

pub fn leaf_granularity_justification(&self) -> &String

Source

pub fn balance_symmetry(&self) -> &f32

Source

pub fn balance_symmetry_confidence(&self) -> &f64

Source

pub fn balance_symmetry_justification(&self) -> &String

Source

pub fn complexity(&self) -> &JustifiedConfigurationComplexity

Source

pub fn complexity_confidence(&self) -> &f64

Source

pub fn complexity_justification(&self) -> &String

Source

pub fn level_specific(&self) -> &Option<JustifiedTreeLevelSpecificConfiguration>

Source

pub fn level_specific_confidence(&self) -> &f64

Source

pub fn level_specific_justification(&self) -> &String

Source

pub fn weighted_branching( &self, ) -> &Option<JustifiedWeightedBranchingConfiguration>

Source

pub fn weighted_branching_confidence(&self) -> &f64

Source

pub fn weighted_branching_justification(&self) -> &String

Source

pub fn level_skipping(&self) -> &Option<JustifiedLevelSkippingConfiguration>

Source

pub fn level_skipping_confidence(&self) -> &f64

Source

pub fn level_skipping_justification(&self) -> &String

Source

pub fn capstone(&self) -> &Option<JustifiedCapstoneGenerationConfiguration>

Source

pub fn capstone_confidence(&self) -> &f64

Source

pub fn capstone_justification(&self) -> &String

Source

pub fn ordering(&self) -> &Option<JustifiedSubBranchOrdering>

Source

pub fn ordering_confidence(&self) -> &f64

Source

pub fn ordering_justification(&self) -> &String

Source

pub fn ai_confidence( &self, ) -> &Option<JustifiedAiTreeBranchingConfidenceConfiguration>

Source

pub fn ai_confidence_confidence(&self) -> &f64

Source

pub fn ai_confidence_justification(&self) -> &String

Source

pub fn aggregator_preference(&self) -> &f32

Source

pub fn aggregator_preference_confidence(&self) -> &f64

Source

pub fn aggregator_preference_justification(&self) -> &String

Source

pub fn allow_early_leaves(&self) -> &bool

Source

pub fn allow_early_leaves_confidence(&self) -> &f64

Source

pub fn allow_early_leaves_justification(&self) -> &String

Source

pub fn partial_subbranch_probability(&self) -> &f32

Source

pub fn partial_subbranch_probability_confidence(&self) -> &f64

Source

pub fn partial_subbranch_probability_justification(&self) -> &String

Source

pub fn tree_expansion_policy(&self) -> &JustifiedTreeExpansionPolicy

Source

pub fn tree_expansion_policy_confidence(&self) -> &f64

Source

pub fn tree_expansion_policy_justification(&self) -> &String

Source

pub fn aggregator_depth_limit(&self) -> &Option<u8>

Source

pub fn aggregator_depth_limit_confidence(&self) -> &f64

Source

pub fn aggregator_depth_limit_justification(&self) -> &String

Source

pub fn dispatch_depth_limit(&self) -> &Option<u8>

Source

pub fn dispatch_depth_limit_confidence(&self) -> &f64

Source

pub fn dispatch_depth_limit_justification(&self) -> &String

Source

pub fn leaf_min_depth(&self) -> &Option<u8>

Source

pub fn leaf_min_depth_confidence(&self) -> &f64

Source

pub fn leaf_min_depth_justification(&self) -> &String

Source§

impl JustifiedGrowerTreeConfiguration

Source

pub fn set_target_name( &mut self, val: String, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_target_name_confidence( &mut self, val: f64, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_target_name_justification( &mut self, val: String, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_depth(&mut self, val: u8) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_depth_confidence( &mut self, val: f64, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_depth_justification( &mut self, val: String, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_breadth(&mut self, val: u8) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_breadth_confidence( &mut self, val: f64, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_breadth_justification( &mut self, val: String, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_density(&mut self, val: u8) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_density_confidence( &mut self, val: f64, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_density_justification( &mut self, val: String, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_leaf_granularity( &mut self, val: f32, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_leaf_granularity_confidence( &mut self, val: f64, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_leaf_granularity_justification( &mut self, val: String, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_balance_symmetry( &mut self, val: f32, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_balance_symmetry_confidence( &mut self, val: f64, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_balance_symmetry_justification( &mut self, val: String, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_complexity( &mut self, val: JustifiedConfigurationComplexity, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_complexity_confidence( &mut self, val: f64, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_complexity_justification( &mut self, val: String, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_level_specific( &mut self, val: Option<JustifiedTreeLevelSpecificConfiguration>, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_level_specific_confidence( &mut self, val: f64, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_level_specific_justification( &mut self, val: String, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_weighted_branching( &mut self, val: Option<JustifiedWeightedBranchingConfiguration>, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_weighted_branching_confidence( &mut self, val: f64, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_weighted_branching_justification( &mut self, val: String, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_level_skipping( &mut self, val: Option<JustifiedLevelSkippingConfiguration>, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_level_skipping_confidence( &mut self, val: f64, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_level_skipping_justification( &mut self, val: String, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_capstone( &mut self, val: Option<JustifiedCapstoneGenerationConfiguration>, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_capstone_confidence( &mut self, val: f64, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_capstone_justification( &mut self, val: String, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_ordering( &mut self, val: Option<JustifiedSubBranchOrdering>, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_ordering_confidence( &mut self, val: f64, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_ordering_justification( &mut self, val: String, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_ai_confidence( &mut self, val: Option<JustifiedAiTreeBranchingConfidenceConfiguration>, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_ai_confidence_confidence( &mut self, val: f64, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_ai_confidence_justification( &mut self, val: String, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_aggregator_preference( &mut self, val: f32, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_aggregator_preference_confidence( &mut self, val: f64, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_aggregator_preference_justification( &mut self, val: String, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_allow_early_leaves( &mut self, val: bool, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_allow_early_leaves_confidence( &mut self, val: f64, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_allow_early_leaves_justification( &mut self, val: String, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_partial_subbranch_probability( &mut self, val: f32, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_partial_subbranch_probability_confidence( &mut self, val: f64, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_partial_subbranch_probability_justification( &mut self, val: String, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_tree_expansion_policy( &mut self, val: JustifiedTreeExpansionPolicy, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_tree_expansion_policy_confidence( &mut self, val: f64, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_tree_expansion_policy_justification( &mut self, val: String, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_aggregator_depth_limit( &mut self, val: Option<u8>, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_aggregator_depth_limit_confidence( &mut self, val: f64, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_aggregator_depth_limit_justification( &mut self, val: String, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_dispatch_depth_limit( &mut self, val: Option<u8>, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_dispatch_depth_limit_confidence( &mut self, val: f64, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_dispatch_depth_limit_justification( &mut self, val: String, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_leaf_min_depth( &mut self, val: Option<u8>, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_leaf_min_depth_confidence( &mut self, val: f64, ) -> &mut JustifiedGrowerTreeConfiguration

Source

pub fn set_leaf_min_depth_justification( &mut self, val: String, ) -> &mut JustifiedGrowerTreeConfiguration

Source§

impl JustifiedGrowerTreeConfiguration

Source

pub fn stamp(&self) -> String

This method is just an alias for produce_concrete_growth_instructions

Source

pub fn produce_concrete_growth_instructions(&self) -> String

Produces a coherent, human-readable set of instructions describing exactly how to grow a tree that conforms to this configuration, assuming no prior knowledge from the reader.

It includes a descriptive explanation for each relevant parameter, explaining both what the parameter means and why this particular value matters for shaping the resulting tree.

Fields or sub-configurations which are not set (i.e. None) are omitted from the instructions.

Enum variants that were not chosen are also omitted.

Trait Implementations§

Source§

impl Clone for JustifiedGrowerTreeConfiguration

Source§

fn clone(&self) -> JustifiedGrowerTreeConfiguration

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for JustifiedGrowerTreeConfiguration

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for JustifiedGrowerTreeConfiguration

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<JustifiedGrowerTreeConfiguration, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<JustifiedGrowerTreeConfiguration> for GrowerTreeConfiguration

Source§

fn from(value: JustifiedGrowerTreeConfiguration) -> GrowerTreeConfiguration

Converts to this type from the input type.
Source§

impl FuzzyFromJsonValue for JustifiedGrowerTreeConfiguration

Source§

fn fuzzy_from_json_value( value: &Value, ) -> Result<JustifiedGrowerTreeConfiguration, FuzzyFromJsonValueError>

Source§

impl PartialEq for JustifiedGrowerTreeConfiguration

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for JustifiedGrowerTreeConfiguration

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for JustifiedGrowerTreeConfiguration

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert 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>

Convert 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)

Convert &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)

Convert &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
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoBox<dyn Any + Send> for T
where T: Any + Send,

Source§

fn into_box(self) -> Box<dyn Any + Send>

Convert self into the appropriate boxed form.
Source§

impl<T> IntoBox<dyn Any + Sync + Send> for T
where T: Any + Send + Sync,

Source§

fn into_box(self) -> Box<dyn Any + Sync + Send>

Convert self into the appropriate boxed form.
Source§

impl<T> IntoBox<dyn Any> for T
where T: Any,

Source§

fn into_box(self) -> Box<dyn Any>

Convert self into the appropriate boxed form.
Source§

impl<T> IntoCollection<T> for T

Source§

fn into_collection<A>(self) -> SmallVec<A>
where A: Array<Item = T>,

Converts self into a collection.
Source§

fn mapped<U, F, A>(self, f: F) -> SmallVec<A>
where F: FnMut(T) -> U, A: Array<Item = U>,

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<T> Paint for T
where T: ?Sized,

Source§

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 primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example
println!("{}", value.primary());
Source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example
println!("{}", value.fixed(color));
Source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example
println!("{}", value.rgb(r, g, b));
Source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example
println!("{}", value.black());
Source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example
println!("{}", value.red());
Source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example
println!("{}", value.green());
Source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example
println!("{}", value.yellow());
Source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example
println!("{}", value.blue());
Source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example
println!("{}", value.magenta());
Source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example
println!("{}", value.cyan());
Source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example
println!("{}", value.white());
Source§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlack].

§Example
println!("{}", value.bright_black());
Source§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightRed].

§Example
println!("{}", value.bright_red());
Source§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightGreen].

§Example
println!("{}", value.bright_green());
Source§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightYellow].

§Example
println!("{}", value.bright_yellow());
Source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example
println!("{}", value.bright_blue());
Source§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.bright_magenta());
Source§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightCyan].

§Example
println!("{}", value.bright_cyan());
Source§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightWhite].

§Example
println!("{}", value.bright_white());
Source§

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>

Returns self with the bg() set to [Color :: Primary].

§Example
println!("{}", value.on_primary());
Source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example
println!("{}", value.on_fixed(color));
Source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
Source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example
println!("{}", value.on_black());
Source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example
println!("{}", value.on_red());
Source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example
println!("{}", value.on_green());
Source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example
println!("{}", value.on_yellow());
Source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example
println!("{}", value.on_blue());
Source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example
println!("{}", value.on_magenta());
Source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example
println!("{}", value.on_cyan());
Source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example
println!("{}", value.on_white());
Source§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlack].

§Example
println!("{}", value.on_bright_black());
Source§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightRed].

§Example
println!("{}", value.on_bright_red());
Source§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightGreen].

§Example
println!("{}", value.on_bright_green());
Source§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
Source§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlue].

§Example
println!("{}", value.on_bright_blue());
Source§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
Source§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightCyan].

§Example
println!("{}", value.on_bright_cyan());
Source§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightWhite].

§Example
println!("{}", value.on_bright_white());
Source§

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 bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example
println!("{}", value.bold());
Source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example
println!("{}", value.dim());
Source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example
println!("{}", value.italic());
Source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example
println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

§Example
println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example
println!("{}", value.rapid_blink());
Source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example
println!("{}", value.invert());
Source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example
println!("{}", value.conceal());
Source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example
println!("{}", value.strike());
Source§

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 mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example
println!("{}", value.mask());
Source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example
println!("{}", value.wrap());
Source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example
println!("{}", value.linger());
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.

Returns self with the quirk() set to [Quirk :: Clear].

§Example
println!("{}", value.clear());
Source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example
println!("{}", value.resetting());
Source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example
println!("{}", value.bright());
Source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example
println!("{}", value.on_bright());
Source§

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);
Source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more