Enum ValidationWarning

#[non_exhaustive]
pub enum ValidationWarning {
    MixedScriptString(MixedScriptString),
    BidiCharsInString(BidiCharsInString),
    BidiCharsInIdentifier(BidiCharsInIdentifier),
    MixedScriptIdentifier(MixedScriptIdentifier),
    ConfusableIdentifier(ConfusableIdentifier),
    ImpossiblePolicy(ImpossiblePolicy),
}

Represents the different kinds of validation warnings and information specific to that warning. Marked as non_exhaustive to allow adding additional warnings in the future as a non-breaking change.

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

MixedScriptString(MixedScriptString)

A string contains mixed scripts. Different scripts can contain visually similar characters which may be confused for each other.

BidiCharsInString(BidiCharsInString)

A string contains BIDI control characters. These can be used to create crafted pieces of code that obfuscate true control flow.

BidiCharsInIdentifier(BidiCharsInIdentifier)

An id contains BIDI control characters. These can be used to create crafted pieces of code that obfuscate true control flow.

MixedScriptIdentifier(MixedScriptIdentifier)

An id contains mixed scripts. This can cause characters to be confused for each other.

ConfusableIdentifier(ConfusableIdentifier)

An id contains characters that fall outside of the General Security Profile for Identifiers. We recommend adhering to this if possible. See Unicode® Technical Standard #39 for more info.

ImpossiblePolicy(ImpossiblePolicy)

The typechecker found that a policy condition will always evaluate to false.

Implementations

impl ValidationWarning

pub fn policy_id(&self) -> &PolicyId

Extract the policy id of the policy where the validator found the issue.

Trait Implementations

impl Clone for ValidationWarning

fn clone(&self) -> ValidationWarning

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ValidationWarning

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

Formats the value using the given formatter.

impl Diagnostic for ValidationWarning

fn code(&self) -> Option<Box<dyn Display + '_>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or enums will work just fine.

fn help(&self) -> Option<Box<dyn Display + '_>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic.

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn related(&self) -> Option<Box<dyn Iterator<Item = &dyn Diagnostic> + '_>>

Additional related Diagnostics.

fn url(&self) -> Option<Box<dyn Display + '_>>

URL to visit for a more detailed explanation/help about this Diagnostic.

fn diagnostic_source(&self) -> Option<&dyn Diagnostic>

The cause of the error.

impl Display for ValidationWarning

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

Formats the value using the given formatter.

impl Error for ValidationWarning

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<BidiCharsInIdentifier> for ValidationWarning

fn from(source: BidiCharsInIdentifier) -> Self

Converts to this type from the input type.

impl From<BidiCharsInString> for ValidationWarning

fn from(source: BidiCharsInString) -> Self

Converts to this type from the input type.

impl From<ConfusableIdentifier> for ValidationWarning

fn from(source: ConfusableIdentifier) -> Self

Converts to this type from the input type.

impl From<ImpossiblePolicy> for ValidationWarning

fn from(source: ImpossiblePolicy) -> Self

Converts to this type from the input type.

impl From<MixedScriptIdentifier> for ValidationWarning

fn from(source: MixedScriptIdentifier) -> Self

Converts to this type from the input type.

impl From<MixedScriptString> for ValidationWarning

fn from(source: MixedScriptString) -> Self

Converts to this type from the input type.