Enum substrait_validator::output::diagnostic::Classification

pub enum Classification {
    Unclassified,
    NotYetImplemented,
    IllegalValue,
    IllegalValueInHint,
    IllegalUri,
    IllegalGlob,
    Deprecation,
    Experimental,
    Proto,
    ProtoParseFailed,
    ProtoMissingField,
    ProtoAny,
    ProtoMissingAnyDeclaration,
    Yaml,
    YamlResolutionDisabled,
    YamlResolutionFailed,
    YamlParseFailed,
    YamlSchemaValidationFailed,
    YamlMissingKey,
    YamlMissingElement,
    YamlInvalidType,
    Link,
    LinkMissingAnchor,
    LinkMissingFunctionName,
    LinkMissingTypeName,
    LinkMissingTypeVariationName,
    LinkAnchorZero,
    Type,
    TypeUnknown,
    TypeMismatchedParameters,
    TypeMismatchedFieldNameAssociations,
    TypeInvalidSwizzle,
    TypeMismatch,
    TypeStructRequired,
    TypeMismatchedVariation,
    TypeMismatchedNullability,
    Relation,
    RelationRootMissing,
    RelationMissing,
    RelationInvalid,
    Expression,
    ExpressionFieldRefMissingStream,
    ExpressionIllegalLiteralValue,
    ExpressionFunctionDefinitionUnavailable,
    ExpressionIllegalSubquery,
    Redundant,
    RedundantProtoAnyDeclaration,
    RedundantExtensionDefition,
    RedundantFunctionDeclaration,
    RedundantTypeDeclaration,
    RedundantTypeVariationDeclaration,
    RedundantListSlice,
    RedundantField,
}

Enumeration for the particular types of diagnostics we might encounter.

Numbers must be assigned as follows:

• the group identifier is represented by the thousands digit and up;
• the first classification for each group (i.e. divisible by 1000) is reserved for diagnostics that have no more specific information attached to them: their description must be hidden and related to the group name;
• group 0 is a sort of null group, where no group information is known;
• all enum variant names for classifications belonging to a group (except the null group) must be prefixed by the group name;
• for backward/forward-compatibility, numbers should not be reassigned.

The Description and HiddenDescription enum properties define a description of the class. When Description is used, the description is prefixed before the error message; when HiddenDescription is used, the message is not prefixed, and should thus be sufficiently specific to not need it. The latter is useful to reduce the amount of redundant information in a message.

Variants

Unclassified

NotYetImplemented

IllegalValue

IllegalValueInHint

IllegalUri

IllegalGlob

Deprecation

Experimental

Proto

ProtoParseFailed

ProtoMissingField

ProtoAny

ProtoMissingAnyDeclaration

Yaml

YamlResolutionDisabled

YamlResolutionFailed

YamlParseFailed

YamlSchemaValidationFailed

YamlMissingKey

YamlMissingElement

YamlInvalidType

Link

LinkMissingAnchor

LinkMissingFunctionName

LinkMissingTypeName

LinkMissingTypeVariationName

LinkAnchorZero

Type

TypeUnknown

TypeMismatchedParameters

TypeMismatchedFieldNameAssociations

TypeInvalidSwizzle

TypeMismatch

TypeStructRequired

TypeMismatchedVariation

TypeMismatchedNullability

Relation

RelationRootMissing

RelationMissing

RelationInvalid

Expression

ExpressionFieldRefMissingStream

ExpressionIllegalLiteralValue

ExpressionFunctionDefinitionUnavailable

ExpressionIllegalSubquery

Redundant

RedundantProtoAnyDeclaration

RedundantExtensionDefition

RedundantFunctionDeclaration

RedundantTypeDeclaration

RedundantTypeVariationDeclaration

RedundantListSlice

RedundantField

Implementations

impl Classification

pub fn code(&self) -> u32

Returns the complete code for this classification.

pub fn name(&self) -> String

Returns the name of the classiciation.

pub fn group_code(&self) -> u32

Returns the group code for this classification.

pub fn group(&self) -> Classification

Returns the group variant for this classification.

pub fn sub_code(&self) -> u32

Returns the code for this classification within its group.

pub fn description(&self) -> &str

Returns the description of this classification.

pub fn from_code(code: u32) -> Option<Self>

Returns the classification associated with the given code, if any.

pub fn group_from_code(code: u32) -> Option<Self>

Returns the group classification associated with the given code, if any.

pub fn from_group(group: u32) -> Option<Self>

Returns the group classification associated with the given group.

pub fn parent(code: u32) -> u32

Returns the “parent” code for the given code. For non-group codes, this is the code of their group (code rounded down to thousands). For group codes, this is 0.

pub fn format_message(&self, message: &Message, f: &mut Formatter<'_>) -> Result

Formats a Message with this classification.

Trait Implementations

impl Clone for Classification

fn clone(&self) -> Classification

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Classification

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

Formats the value using the given formatter.

impl Default for Classification

fn default() -> Self

Returns the “default value” for a type.

impl EnumProperty for Classification

fn get_str(&self, prop: &str) -> Option<&'static str>

fn get_int(&self, _prop: &str) -> Option<usize>

fn get_bool(&self, _prop: &str) -> Option<bool>

impl From<Classification> for u32

fn from(classification: Classification) -> Self

Converts a Classification into its error code.

impl FromPrimitive for Classification

fn from_i64(n: i64) -> Option<Self>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(n: u64) -> Option<Self>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl Hash for Classification

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl IntoEnumIterator for Classification

type Iterator = ClassificationIter

fn iter() -> ClassificationIter

impl PartialEq<Classification> for Classification

fn eq(&self, other: &Classification) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Copy for Classification

impl Eq for Classification

impl StructuralEq for Classification

impl StructuralPartialEq for Classification