Enum Code

Source

pub enum Code {
Show 148 variants    TypeMismatch,
    InvalidBinaryOperator,
    StringInterpolationRewrite,
    ReturnTypeMismatch,
    AssignmentTypeMismatch,
    ArgumentTypeMismatch,
    VariableTypeMismatch,
    ClosureReturnTypeMismatch,
    FieldTypeMismatch,
    MethodTypeMismatch,
    GenericTypeArgumentUnsupported,
    GenericTypeArgumentMismatch,
    GenericTypeArgumentArity,
    TypeParameterArity,
    WhereConstraintMismatch,
    IterableExpected,
    InvalidIndexType,
    CallableExpected,
    InvalidCast,
    UnknownTypeName,
    InvalidVariantUse,
    InvalidStructLiteral,
    InvalidEnumConstruct,
    InvalidPatternBinding,
    InvalidOptionalAccess,
    ParserUnexpectedToken,
    ParserUnexpectedEof,
    ParserUnexpectedCharacter,
    ParserUnterminatedString,
    ParserUnterminatedBlockComment,
    UndefinedVariable,
    UndefinedFunction,
    UnknownAttribute,
    UnknownField,
    UnknownMethod,
    DuplicateArgument,
    UnknownOption,
    UnknownBuiltin,
    DeprecatedFunction,
    UnknownDeclaration,
    InvalidAttributeTarget,
    InvalidAttributeArgument,
    InvalidMainSignature,
    CapabilityPayloadInvalid,
    HitlMissingApprovalPolicy,
    HitlInvalidApprovalArgument,
    CapabilityResultUnchecked,
    CapabilityUnknownOperation,
    CapabilityCallStaticNameRequired,
    CapabilityBindingInvalid,
    UnknownLlmOption,
    DeprecatedLlmOption,
    LlmSchemaMissing,
    LlmSchemaInvalid,
    LlmProviderIdentityBranch,
    OrchestrationArity,
    OrchestrationType,
    AgentDefinitionInvalid,
    WorkflowDefinitionInvalid,
    ToolDefinitionInvalid,
    PipelineDefinitionInvalid,
    InvalidSelectConstruct,
    UnreachableCode,
    FlowInvariantAttributeInvalid,
    ExecutionTargetMissing,
    DeprecatedStdlibSymbol,
    StdlibUsageInvalid,
    BuiltinArity,
    PromptTemplateParse,
    PromptVariantExplosion,
    PromptInjectionRisk,
    PromptProviderIdentityBranch,
    PromptToolSurfaceUnknown,
    PromptToolSurfaceDeferredReference,
    PromptTargetMissing,
    ModuleImportUnresolved,
    ModuleImportUnused,
    ModuleImportOrder,
    ModuleExportInvalid,
    ModuleImportCollision,
    ModuleReExportConflict,
    LintRenamedStdlibSymbol,
    LintCyclomaticComplexity,
    LintNamingConvention,
    LintEagerCollectionConversion,
    LintRedundantClone,
    LintLongRunningWithoutCleanup,
    LintMcpToolAnnotations,
    LintPrOpenWithoutSecretScan,
    LintShadowVariable,
    LintPersonaHookTarget,
    LintDeadCodeAfterReturn,
    LintLetThenReturn,
    LintUnhandledApprovalResult,
    LintUnusedVariable,
    LintUnusedPatternBinding,
    LintUnusedParameter,
    LintUnusedImport,
    LintMutableNeverReassigned,
    LintUnusedFunction,
    LintUnusedType,
    LintPersonaBodyMustCallSteps,
    LintUndefinedFunction,
    LintPipelineReturnType,
    LintMissingHarndoc,
    LintAssertOutsideTest,
    LintPromptInjectionRisk,
    LintConnectorEffectPolicy,
    LintUnnecessaryCast,
    LintUntypedDictAccess,
    LintConstantLogicalOperand,
    LintPointlessComparison,
    LintComparisonToBool,
    LintInvalidBinaryOpLiteral,
    LintRedundantNilTernary,
    LintEmptyBlock,
    LintUnnecessaryElseReturn,
    LintDuplicateMatchArm,
    LintRequireInTest,
    LintBreakOutsideLoop,
    LintTemplateParse,
    LintBlankLineBetweenItems,
    LintTrailingComma,
    LintUnnecessaryParentheses,
    LintTemplateVariantExplosion,
    LintRequireFileHeader,
    LintTemplateProviderIdentityBranch,
    LintImportOrder,
    LintPreferOptionalShorthand,
    LintLegacyDocComment,
    LintDeprecatedLlmOptions,
    LintUnnecessarySafeNavigation,
    FormatterParseFailed,
    FormatterWouldReformat,
    FormatterTrailingComma,
    ImportResolutionFailed,
    ImportSymbolMissing,
    ImportCycle,
    ImmutableAssignment,
    MutableNeverReassigned,
    OwnershipEscape,
    BoundaryValueUnvalidated,
    RescueOutsideFunction,
    TryOutsideFunction,
    InvalidRescueConstruct,
    NonExhaustiveMatch,
    DuplicateMatchArm,
    InvalidMatchPattern,
}

Expand description

Stable diagnostic identifier.

Variants§

§

InvalidMatchPattern

Implementations§

Source §

impl Code

Source

pub const ALL: &'static [Code]

Source

pub const fn as_str(self) -> &'static str

Source

pub const fn category(self) -> Category

Source

pub const fn summary(self) -> &'static str

Source

pub const fn explanation(self) -> &'static str

Full markdown explanation embedded at compile time. Every registered code must ship a matching file under diagnostic_codes/explanations/; missing files fail the build.

Source §

impl Code

Source

pub const fn registry() -> &'static [RegistryEntry]

Codes that an agent should consider alongside this one when planning repairs. Curated per-code — typically near-neighbours in the same category that share a fix shape. Returns an empty slice for codes without curated cross-references.

Source §

impl Code

Source

pub const fn repair_template(self) -> Option<&'static RepairTemplate>

Look up the default repair template attached to this diagnostic code, or None if no actionable fix shape is registered.

Trait Implementations§

Source §

impl Clone for Code

Source §

fn clone(&self) -> Code

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 Code

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Display for Code

Source §

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

Formats the value using the given formatter. Read more

Source §

impl FromStr for Code

Source §

type Err = ParseCodeError

The associated error which can be returned from parsing.

Source §

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more

Source §

impl Hash for Code

Source §

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

Source §

impl Ord for Code

Source §

fn cmp(&self, other: &Code) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more

1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more

1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more

Source §

impl PartialEq for Code

Source §

fn eq(&self, other: &Code) -> 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 PartialOrd for Code

Source §

fn partial_cmp(&self, other: &Code) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more

1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more

Source §

impl Copy for Code

Source §

impl Eq for Code

Source §

impl StructuralPartialEq for Code

Auto Trait Implementations§

§

impl Freeze for Code

§

impl RefUnwindSafe for Code

§

impl Send for Code

§

impl Sync for Code

§

impl Unpin for Code

§

impl UnsafeUnpin for Code

§

impl UnwindSafe for Code

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> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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> 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());

Source §

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

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

§Example

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

Source §

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

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> 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> ToString for T
where T: Display + ?Sized,

Source §

fn to_string(&self) -> String

Converts the given value to a String. Read more

Source §

impl<T, U> TryFrom 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>::Error>

Performs the conversion.

Source §

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

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

Enum Code Copy item path

Variants§

TypeMismatch

InvalidBinaryOperator

StringInterpolationRewrite

ReturnTypeMismatch

AssignmentTypeMismatch

ArgumentTypeMismatch

VariableTypeMismatch

ClosureReturnTypeMismatch

FieldTypeMismatch

MethodTypeMismatch

GenericTypeArgumentUnsupported

GenericTypeArgumentMismatch

GenericTypeArgumentArity

TypeParameterArity

WhereConstraintMismatch

IterableExpected

InvalidIndexType

CallableExpected

InvalidCast

UnknownTypeName

InvalidVariantUse

InvalidStructLiteral

InvalidEnumConstruct

InvalidPatternBinding

InvalidOptionalAccess

ParserUnexpectedToken

ParserUnexpectedEof

ParserUnexpectedCharacter

ParserUnterminatedString

ParserUnterminatedBlockComment

UndefinedVariable

UndefinedFunction

UnknownAttribute

UnknownField

UnknownMethod

DuplicateArgument

UnknownOption

UnknownBuiltin

DeprecatedFunction

UnknownDeclaration

InvalidAttributeTarget

InvalidAttributeArgument

InvalidMainSignature

CapabilityPayloadInvalid

HitlMissingApprovalPolicy

HitlInvalidApprovalArgument

CapabilityResultUnchecked

CapabilityUnknownOperation

CapabilityCallStaticNameRequired

CapabilityBindingInvalid

UnknownLlmOption

DeprecatedLlmOption

LlmSchemaMissing

LlmSchemaInvalid

LlmProviderIdentityBranch

OrchestrationArity

OrchestrationType

AgentDefinitionInvalid

WorkflowDefinitionInvalid

ToolDefinitionInvalid

PipelineDefinitionInvalid

InvalidSelectConstruct

UnreachableCode

FlowInvariantAttributeInvalid

ExecutionTargetMissing

DeprecatedStdlibSymbol

StdlibUsageInvalid

BuiltinArity

PromptTemplateParse

PromptVariantExplosion

PromptInjectionRisk

PromptProviderIdentityBranch

PromptToolSurfaceUnknown

PromptToolSurfaceDeferredReference

PromptTargetMissing

ModuleImportUnresolved

ModuleImportUnused

ModuleImportOrder

Enum Code