pub struct CompiledRule { /* private fields */ }Expand description
A rule whose matcher has been compiled and is ready to run.
Implementations§
Source§impl CompiledRule
impl CompiledRule
Sourcepub fn compile(rule: &Rule) -> Result<Self, RulesError>
pub fn compile(rule: &Rule) -> Result<Self, RulesError>
Resolve the rule’s language and grammar, then compile its matcher.
Sourcepub fn applicability(&self) -> Applicability
pub fn applicability(&self) -> Applicability
Whether this rule’s fix may be auto-applied (machine-applicable) or is opt-in only (suggestion).
Sourcepub fn severity(&self) -> Severity
pub fn severity(&self) -> Severity
The rule’s diagnostic severity (the default for any diagnostic the rule produces).
Sourcepub fn message(&self) -> &str
pub fn message(&self) -> &str
The rule’s static diagnostic message (empty for a search-only rule).
Sourcepub fn run(&self, source: &str) -> Result<Vec<RuleMatch>, RulesError>
pub fn run(&self, source: &str) -> Result<Vec<RuleMatch>, RulesError>
Run the compiled rule against source, returning matches in
document order. Matches that fail any where constraint are dropped.
Sourcepub fn apply(&self, source: &str) -> Result<CodemodResult, RulesError>
pub fn apply(&self, source: &str) -> Result<CodemodResult, RulesError>
Apply this codemod rule’s fix to source, returning the rewritten
text plus the per-match edits. Each match’s fix template is
interpolated from its captured metavars plus any transform-derived
ones. Errors if the rule has no fix.
This computes the preview only — it does not enforce the safety gate.
Use CompiledRule::auto_apply to refuse non-machine-applicable
fixes, or CompiledRule::apply_checked to also assert idempotency.
Sourcepub fn auto_apply(&self, source: &str) -> Result<CodemodResult, RulesError>
pub fn auto_apply(&self, source: &str) -> Result<CodemodResult, RulesError>
Like CompiledRule::apply, but refuses to apply a fix whose
safety is above the machine-applicable threshold (scope-local and
riskier). This is the gate harn codemod --apply uses by default.
Sourcepub fn apply_checked(&self, source: &str) -> Result<CodemodResult, RulesError>
pub fn apply_checked(&self, source: &str) -> Result<CodemodResult, RulesError>
Like CompiledRule::apply, but fails if the fix is not idempotent.
Used by the codemod runner and the rule-test harness to assert a fix
reaches a fixed point.
Sourcepub fn diagnostics(&self, source: &str) -> Result<Vec<Diagnostic>, RulesError>
pub fn diagnostics(&self, source: &str) -> Result<Vec<Diagnostic>, RulesError>
Run the rule and produce one Diagnostic per match — the surface
the linter (Epic C) and the LSP convert into LintDiagnostic /
FixEdit. Each diagnostic carries the interpolated fix (if any) and
its applicability tier.
Auto Trait Implementations§
impl Freeze for CompiledRule
impl RefUnwindSafe for CompiledRule
impl Send for CompiledRule
impl Sync for CompiledRule
impl Unpin for CompiledRule
impl UnsafeUnpin for CompiledRule
impl UnwindSafe for CompiledRule
Blanket Implementations§
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
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> 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> 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>
renamed to 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);