pub struct MatchingRules {
pub rules: HashMap<Category, MatchingRuleCategory>,
}Expand description
Data structure for representing a collection of matchers
Fields§
§rules: HashMap<Category, MatchingRuleCategory>Categories of matching rules
Implementations§
Source§impl MatchingRules
impl MatchingRules
Sourcepub fn is_empty(&self) -> bool
pub fn is_empty(&self) -> bool
If the matching rules are empty (that is there are no rules assigned to any categories)
Sourcepub fn is_not_empty(&self) -> bool
pub fn is_not_empty(&self) -> bool
If the matching rules are not empty (that is there is at least one rule assigned to a category)
Sourcepub fn add_category<S>(&mut self, category: S) -> &mut MatchingRuleCategory
pub fn add_category<S>(&mut self, category: S) -> &mut MatchingRuleCategory
Adds the category to the map of rules
Sourcepub fn categories(&self) -> HashSet<Category>
pub fn categories(&self) -> HashSet<Category>
Returns all the category names in this rule set
Sourcepub fn rules_for_category<S>(&self, category: S) -> Option<MatchingRuleCategory>
pub fn rules_for_category<S>(&self, category: S) -> Option<MatchingRuleCategory>
Returns the category of rules for a given category name
Sourcepub fn matcher_is_defined<S>(&self, category: S, path: &Vec<&str>) -> bool
pub fn matcher_is_defined<S>(&self, category: S, path: &Vec<&str>) -> bool
If there is a matcher defined for the category and path
Sourcepub fn wildcard_matcher_is_defined<S>(
&self,
category: S,
path: &Vec<&str>,
) -> bool
pub fn wildcard_matcher_is_defined<S>( &self, category: S, path: &Vec<&str>, ) -> bool
If there is a wildcard matcher defined for the category and path
Sourcepub fn type_matcher_defined<S>(&self, category: S, path: &Vec<&str>) -> bool
pub fn type_matcher_defined<S>(&self, category: S, path: &Vec<&str>) -> bool
If there is a type matcher defined for the category and path
Sourcepub fn resolve_matchers<S>(
&self,
category: S,
path: &Vec<&str>,
) -> Option<MatchingRuleCategory>
pub fn resolve_matchers<S>( &self, category: S, path: &Vec<&str>, ) -> Option<MatchingRuleCategory>
Returns a Category filtered with all rules that match the given path.
Sourcepub fn resolve_body_matchers_by_path(&self, path: &Vec<&str>) -> RuleList
pub fn resolve_body_matchers_by_path(&self, path: &Vec<&str>) -> RuleList
Returns a list of rules from the body category that match the given path
Sourcepub fn rename<S>(&self, old_name: S, new_name: S) -> Self
pub fn rename<S>(&self, old_name: S, new_name: S) -> Self
Clones the matching rules, renaming the category
Sourcepub fn add_rules<S>(&mut self, category: S, rules: MatchingRuleCategory)
pub fn add_rules<S>(&mut self, category: S, rules: MatchingRuleCategory)
Add the rules to the category
Sourcepub fn merge(&mut self, other: &MatchingRules)
pub fn merge(&mut self, other: &MatchingRules)
Merge the rules from the other matching rules into this one.
Trait Implementations§
Source§impl Clone for MatchingRules
impl Clone for MatchingRules
Source§fn clone(&self) -> MatchingRules
fn clone(&self) -> MatchingRules
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for MatchingRules
impl Debug for MatchingRules
Source§impl Default for MatchingRules
impl Default for MatchingRules
Source§impl Display for MatchingRules
impl Display for MatchingRules
Source§impl Hash for MatchingRules
impl Hash for MatchingRules
Source§impl PartialEq for MatchingRules
impl PartialEq for MatchingRules
impl Eq for MatchingRules
Auto Trait Implementations§
impl Freeze for MatchingRules
impl RefUnwindSafe for MatchingRules
impl Send for MatchingRules
impl Sync for MatchingRules
impl Unpin for MatchingRules
impl UnwindSafe for MatchingRules
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> 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> 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);Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<T> ToStringFallible for Twhere
T: Display,
impl<T> ToStringFallible for Twhere
T: Display,
Source§fn try_to_string(&self) -> Result<String, TryReserveError>
fn try_to_string(&self) -> Result<String, TryReserveError>
ToString::to_string, but without panic on OOM.