Enum IssueCode

Source

#[non_exhaustive]
#[repr(u16)]pub enum IssueCode {
Show 322 variants    AbstractClassUsedAsAttribute = 0,
    AbstractInstantiation = 1,
    AlwaysMatchingSwitchCase = 2,
    AmbiguousClassLikeConstantAccess = 3,
    AmbiguousInstantiationTarget = 4,
    AmbiguousObjectMethodAccess = 5,
    AmbiguousObjectPropertyAccess = 6,
    ArrayAppendInReadContext = 7,
    ArrayAppendOverflow = 8,
    ArrayToStringConversion = 9,
    AssignmentToConstant = 10,
    AssignmentToThis = 11,
    AttributeNotRepeatable = 12,
    AvoidCatchingError = 13,
    BackedPropertyReferenceHook = 14,
    CatchTypeNotThrowable = 15,
    ClassMustBeFinal = 16,
    ClassNotMarkedAsAttribute = 17,
    CloneInsideLoop = 18,
    ConditionIsTooComplex = 19,
    ConflictingReferenceConstraint = 20,
    ConflictingTemplateEqualityBounds = 21,
    DeprecatedClass = 22,
    DeprecatedClosure = 23,
    DeprecatedConstant = 24,
    DeprecatedFeature = 25,
    DeprecatedFunction = 26,
    DeprecatedMethod = 27,
    DeprecatedTrait = 28,
    DirectTraitConstantAccess = 29,
    DocblockParameterNarrowing = 30,
    DocblockTypeMismatch = 31,
    DuplicateArrayKey = 32,
    DuplicateCaughtType = 33,
    DuplicateClosureUseVariable = 34,
    DuplicateDefinition = 35,
    DuplicateEnumCaseValue = 36,
    DuplicateNamedArgument = 37,
    DynamicStaticMethodCall = 38,
    EmptyMatchExpression = 39,
    EnumInstantiation = 40,
    EnumIteration = 41,
    ExcessTemplateParameter = 42,
    ExperimentalUsage = 43,
    ExpressionIsTooComplex = 44,
    ExtendFinalClass = 45,
    FalsableReturnStatement = 46,
    FalseArgument = 47,
    FalseArrayAccess = 48,
    FalseIterator = 49,
    FalseOperand = 50,
    GenericObjectIteration = 51,
    HiddenGeneratorReturn = 52,
    ImplicitResourceToStringCast = 53,
    ImplicitToStringCast = 54,
    ImpossibleArrayAccess = 55,
    ImpossibleArrayAssignment = 56,
    ImpossibleAssignment = 57,
    ImpossibleCondition = 58,
    ImpossibleKeyCheck = 59,
    ImpossibleNonnullEntryCheck = 60,
    ImpossibleNullTypeComparison = 61,
    ImpossibleTypeComparison = 62,
    ImpreciseType = 63,
    ImpureConstruct = 64,
    ImpureStaticVariable = 65,
    IncompatibleConstantAccess = 66,
    IncompatibleConstantOverride = 67,
    IncompatibleConstantType = 68,
    IncompatibleConstantVisibility = 69,
    IncompatibleParameterCount = 70,
    IncompatibleParameterName = 71,
    IncompatibleParameterType = 72,
    IncompatiblePropertyAccess = 73,
    IncompatiblePropertyDefault = 74,
    IncompatiblePropertyHookParameterType = 75,
    IncompatiblePropertyHookSignature = 76,
    IncompatiblePropertyOverride = 77,
    IncompatiblePropertyReadonly = 78,
    IncompatiblePropertyStatic = 79,
    IncompatiblePropertyType = 80,
    IncompatiblePropertyVisibility = 81,
    IncompatibleReadonlyModifier = 82,
    IncompatibleReturnType = 83,
    IncompatibleStaticModifier = 84,
    IncompatibleTemplateLowerBound = 85,
    IncompatibleVisibility = 86,
    InconsistentTemplate = 87,
    IncorrectClassLikeCasing = 88,
    IncorrectFunctionCasing = 89,
    InterfaceInstantiation = 90,
    InvalidArgument = 91,
    InvalidArrayAccess = 92,
    InvalidArrayAccessAssignmentValue = 93,
    InvalidArrayElement = 94,
    InvalidArrayElementKey = 95,
    InvalidArrayIndex = 96,
    InvalidAssignment = 97,
    InvalidAttributeTarget = 98,
    InvalidBreak = 99,
    InvalidCallable = 100,
    InvalidCatchType = 101,
    InvalidCatchTypeNotClassOrInterface = 102,
    InvalidClassConstantOnString = 103,
    InvalidClassStringExpression = 104,
    InvalidClone = 105,
    InvalidConstantSelector = 106,
    InvalidConstantValue = 107,
    InvalidContinue = 108,
    InvalidDestructuringSource = 109,
    InvalidDocblock = 110,
    InvalidEnumCaseValue = 111,
    InvalidExtend = 112,
    InvalidForeachKey = 113,
    InvalidForeachValue = 114,
    InvalidGeneratorReturnType = 115,
    InvalidGlobal = 116,
    InvalidImplement = 117,
    InvalidIssetExpression = 118,
    InvalidIterator = 119,
    InvalidMemberSelector = 120,
    InvalidMethodAccess = 121,
    InvalidNamedArgument = 122,
    InvalidOperand = 123,
    InvalidOverrideAttribute = 124,
    InvalidParameterDefaultValue = 125,
    InvalidParentType = 126,
    InvalidPassByReference = 127,
    InvalidPropertyAccess = 128,
    InvalidPropertyAssignmentValue = 129,
    InvalidPropertyDefaultValue = 130,
    InvalidPropertyRead = 131,
    InvalidPropertyWrite = 132,
    InvalidReturnStatement = 133,
    InvalidScopeKeywordContext = 134,
    InvalidStaticMethodAccess = 135,
    InvalidStaticMethodCall = 136,
    InvalidStaticPropertyAccess = 137,
    InvalidTemplateParameter = 138,
    InvalidThrow = 139,
    InvalidTraitAliasModifier = 140,
    InvalidTraitUse = 141,
    InvalidTypeCast = 142,
    InvalidUnset = 143,
    InvalidYieldKeyType = 144,
    InvalidYieldValueType = 145,
    LessSpecificArgument = 146,
    LessSpecificNestedArgumentType = 147,
    LessSpecificNestedReturnStatement = 148,
    LessSpecificReturnStatement = 149,
    ListDestructureNegativeKey = 150,
    ListDestructureStringKey = 151,
    ListUsedInReadContext = 152,
    MatchArmAlwaysTrue = 153,
    MatchDefaultArmAlwaysExecuted = 154,
    MatchExpressionOnlyDefaultArm = 155,
    MatchNotExhaustive = 156,
    MatchSubjectTypeIsNever = 157,
    MethodAccessOnNull = 158,
    MismatchedArrayIndex = 159,
    MissingApiOrInternal = 160,
    MissingConstantType = 161,
    MissingConstructor = 162,
    MissingMagicMethod = 163,
    MissingOverrideAttribute = 164,
    MissingParameterType = 165,
    MissingPropertyType = 166,
    MissingRequiredInterface = 167,
    MissingRequiredParent = 168,
    MissingReturnStatement = 169,
    MissingReturnType = 170,
    MissingTemplateParameter = 171,
    MixedArgument = 172,
    MixedArrayAccess = 173,
    MixedArrayAssignment = 174,
    MixedArrayIndex = 175,
    MixedAssignment = 176,
    MixedClone = 177,
    MixedDestructuringShape = 178,
    MixedMethodAccess = 179,
    MixedOperand = 180,
    MixedPropertyAccess = 181,
    MixedPropertyTypeCoercion = 182,
    MixedReturnStatement = 183,
    NameAlreadyInUse = 184,
    NamedArgumentAfterPositional = 185,
    NamedArgumentNotAllowed = 186,
    NamedArgumentOverridesPositional = 187,
    NeverMatchingSwitchCase = 188,
    NeverReturn = 189,
    NoValidCatchTypeFound = 190,
    NoValue = 191,
    NonClassUsedAsAttribute = 192,
    NonDocumentedConstant = 193,
    NonDocumentedMethod = 194,
    NonDocumentedProperty = 195,
    NonExistentAttributeClass = 196,
    NonExistentCatchType = 197,
    NonExistentClass = 198,
    NonExistentClassConstant = 199,
    NonExistentClassLike = 200,
    NonExistentConstant = 201,
    NonExistentFunction = 202,
    NonExistentMethod = 203,
    NonExistentProperty = 204,
    NonExistentUseImport = 205,
    NonIterableObjectIteration = 206,
    NonStaticAbstractImplementation = 207,
    NullArgument = 208,
    NullArrayAccess = 209,
    NullArrayIndex = 210,
    NullIterator = 211,
    NullOperand = 212,
    NullPropertyAccess = 213,
    NullableReturnStatement = 214,
    OverlyWideReturnType = 215,
    OverrideFinalConstant = 216,
    OverrideFinalMethod = 217,
    OverrideFinalProperty = 218,
    OverrideFinalPropertyHook = 219,
    ParadoxicalCondition = 220,
    ParentOutsideClassScope = 221,
    PossibleMethodAccessOnNull = 222,
    PossiblyArrayAppendOverflow = 223,
    PossiblyFalseArgument = 224,
    PossiblyFalseArrayAccess = 225,
    PossiblyFalseIterator = 226,
    PossiblyFalseOperand = 227,
    PossiblyInvalidArgument = 228,
    PossiblyInvalidArrayAccess = 229,
    PossiblyInvalidClone = 230,
    PossiblyInvalidIterator = 231,
    PossiblyInvalidOperand = 232,
    PossiblyNonExistentMethod = 233,
    PossiblyNonExistentProperty = 234,
    PossiblyNullArgument = 235,
    PossiblyNullArrayAccess = 236,
    PossiblyNullArrayIndex = 237,
    PossiblyNullIterator = 238,
    PossiblyNullOperand = 239,
    PossiblyNullPropertyAccess = 240,
    PossiblyStaticAccessOnInterface = 241,
    PossiblyUndefinedArrayIndex = 242,
    PossiblyUndefinedIntArrayIndex = 243,
    PossiblyUndefinedStringArrayIndex = 244,
    PossiblyUndefinedVariable = 245,
    PropertyTypeCoercion = 246,
    PsalmTrace = 247,
    RedundantCast = 248,
    RedundantComparison = 249,
    RedundantCondition = 250,
    RedundantDocblockType = 251,
    RedundantIssetCheck = 252,
    RedundantKeyCheck = 253,
    RedundantLogicalOperation = 254,
    RedundantNonnullEntryCheck = 255,
    RedundantNonnullTypeComparison = 256,
    RedundantNullCoalesce = 257,
    RedundantNullsafeOperator = 258,
    RedundantTypeComparison = 259,
    ReferenceConstraintViolation = 260,
    ReferenceReusedFromConfusingScope = 261,
    ReferenceToUndefinedVariable = 262,
    SelfOutsideClassScope = 263,
    SideEffectsInCondition = 264,
    SkipInKeyedDestructuring = 265,
    SpreadInDestructuring = 266,
    StaticAccessOnInterface = 267,
    StaticOutsideClassScope = 268,
    StringConstantSelector = 269,
    StringMemberSelector = 270,
    TemplateConstraintViolation = 271,
    TooFewArguments = 272,
    TooManyArguments = 273,
    TraitConstantOverride = 274,
    TraitInstantiation = 275,
    TypeConfirmation = 276,
    TypeInspection = 277,
    UnavailableClassConstant = 278,
    UnavailableClassLike = 279,
    UnavailableConstant = 280,
    UnavailableEnumCase = 281,
    UnavailableFunction = 282,
    UnavailableMethod = 283,
    UnavailableProperty = 284,
    UndefinedIntArrayIndex = 285,
    UndefinedStringArrayIndex = 286,
    UndefinedVariable = 287,
    UndefinedVariableInClosureUse = 288,
    UnevaluatedCode = 289,
    UnhandledThrownType = 290,
    UnimplementedAbstractMethod = 291,
    UnimplementedAbstractPropertyHook = 292,
    UninitializedProperty = 293,
    UnknownClassInstantiation = 294,
    UnknownConstantSelectorType = 295,
    UnknownIteratorType = 296,
    UnknownMatchSubjectType = 297,
    UnknownMemberSelectorType = 298,
    UnknownYieldFromIteratorType = 299,
    UnreachableElseClause = 300,
    UnreachableMatchArm = 301,
    UnreachableMatchDefaultArm = 302,
    UnreachableSwitchCase = 303,
    UnreachableSwitchDefault = 304,
    UnresolvableClassConstant = 305,
    UnsafeInstantiation = 306,
    UnusedFunctionCall = 307,
    UnusedMethod = 308,
    UnusedMethodCall = 309,
    UnusedParameter = 310,
    UnusedProperty = 311,
    UnusedStatement = 312,
    UnusedTemplateParameter = 313,
    UselessControlFlow = 314,
    WhereConstraintViolation = 315,
    WriteOnlyProperty = 316,
    YieldFromInvalidKeyType = 317,
    YieldFromInvalidSendType = 318,
    YieldFromInvalidValueType = 319,
    YieldFromNonIterable = 320,
    YieldOutsideFunction = 321,
}

Expand description

An issue code representing a specific type of analysis issue.

Each issue code corresponds to a unique identifier for a particular kind of issue that the analyzer can detect during code analysis.

This enum is non-exhaustive; new issue codes may be added in future versions.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

§

YieldOutsideFunction = 321

Implementations§

Source §

impl IssueCode

Source

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

Source

pub fn as_u16(&self) -> u16

Source

pub fn all() -> &'static [IssueCode]

Trait Implementations§

Source §

impl Borrow<str> for IssueCode

Source §

fn borrow(&self) -> &'static str

Immutably borrows from an owned value. Read more

Source §

impl<'code> Borrow<str> for &'code IssueCode

Source §

fn borrow(&self) -> &'code str

Immutably borrows from an owned value. Read more

Source §

impl Clone for IssueCode

Source §

fn clone(&self) -> IssueCode

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 Copy for IssueCode

Source §

impl Debug for IssueCode

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Display for IssueCode

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Eq for IssueCode

Source §

impl From<IssueCode> for &'static str

Source §

fn from(val: IssueCode) -> Self

Converts to this type from the input type.

Source §

impl From<IssueCode> for String

Source §

fn from(val: IssueCode) -> Self

Converts to this type from the input type.

Source §

impl FromStr for IssueCode

Source §

type Err = &'static str

The associated error which can be returned from parsing.

Source §

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

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

Source §

impl Hash for IssueCode

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 IssueCode

Source §

fn cmp(&self, other: &IssueCode) -> 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 IssueCode

Source §

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

Source §

fn partial_cmp(&self, other: &IssueCode) -> 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 StructuralPartialEq for IssueCode

Source §

impl TryFrom<&str> for IssueCode

Source §

type Error = &'static str

The type returned in the event of a conversion error.

Source §

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations§

§

impl Freeze for IssueCode

§

impl RefUnwindSafe for IssueCode

§

impl Send for IssueCode

§

impl Sync for IssueCode

§

impl Unpin for IssueCode

§

impl UnsafeUnpin for IssueCode

§

impl UnwindSafe for IssueCode

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<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source §

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.

Source §

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

Source §

fn __clone_box(&self, _: Private) -> *mut ()

Source §

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source §

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

Source §

impl<T> Fmt for T
where T: Display,

Source §

fn fg<C>(self, color: C) -> Foreground<Self>
where C: Into<Option<Color>>, Self: Display,

Give this value the specified foreground colour.

Source §

fn bg<C>(self, color: C) -> Background<Self>
where C: Into<Option<Color>>, Self: Display,

Give this value the specified background colour.

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 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> 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());

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

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

Enum IssueCode Copy item path

Variants (Non-exhaustive)§

AbstractClassUsedAsAttribute = 0

AbstractInstantiation = 1

AlwaysMatchingSwitchCase = 2

AmbiguousClassLikeConstantAccess = 3

AmbiguousInstantiationTarget = 4

AmbiguousObjectMethodAccess = 5

AmbiguousObjectPropertyAccess = 6

ArrayAppendInReadContext = 7

ArrayAppendOverflow = 8

ArrayToStringConversion = 9

AssignmentToConstant = 10

AssignmentToThis = 11

AttributeNotRepeatable = 12

AvoidCatchingError = 13

BackedPropertyReferenceHook = 14

CatchTypeNotThrowable = 15

ClassMustBeFinal = 16

ClassNotMarkedAsAttribute = 17

CloneInsideLoop = 18

ConditionIsTooComplex = 19

ConflictingReferenceConstraint = 20

ConflictingTemplateEqualityBounds = 21

DeprecatedClass = 22

DeprecatedClosure = 23

DeprecatedConstant = 24

DeprecatedFeature = 25

DeprecatedFunction = 26

DeprecatedMethod = 27

DeprecatedTrait = 28

DirectTraitConstantAccess = 29

DocblockParameterNarrowing = 30

DocblockTypeMismatch = 31

DuplicateArrayKey = 32

DuplicateCaughtType = 33

DuplicateClosureUseVariable = 34

DuplicateDefinition = 35

DuplicateEnumCaseValue = 36

DuplicateNamedArgument = 37

DynamicStaticMethodCall = 38

EmptyMatchExpression = 39

EnumInstantiation = 40

EnumIteration = 41

ExcessTemplateParameter = 42

ExperimentalUsage = 43

ExpressionIsTooComplex = 44

ExtendFinalClass = 45

FalsableReturnStatement = 46

FalseArgument = 47

FalseArrayAccess = 48

FalseIterator = 49

FalseOperand = 50

GenericObjectIteration = 51

HiddenGeneratorReturn = 52

ImplicitResourceToStringCast = 53

ImplicitToStringCast = 54

ImpossibleArrayAccess = 55

ImpossibleArrayAssignment = 56

ImpossibleAssignment = 57

ImpossibleCondition = 58

ImpossibleKeyCheck = 59

ImpossibleNonnullEntryCheck = 60

ImpossibleNullTypeComparison = 61

ImpossibleTypeComparison = 62

ImpreciseType = 63

ImpureConstruct = 64

ImpureStaticVariable = 65

IncompatibleConstantAccess = 66

IncompatibleConstantOverride = 67

IncompatibleConstantType = 68

IncompatibleConstantVisibility = 69

IncompatibleParameterCount = 70

IncompatibleParameterName = 71

IncompatibleParameterType = 72

IncompatiblePropertyAccess = 73

IncompatiblePropertyDefault = 74

IncompatiblePropertyHookParameterType = 75

IncompatiblePropertyHookSignature = 76

IncompatiblePropertyOverride = 77

Enum IssueCode