Enum ValidationError 

pub enum ValidationError {
    NoModuleName,
    DuplicateModuleName(String),
    InvalidModuleName(String, &'static str),
    DuplicateFunctionName {
        module: String,
        function: String,
    },
    DuplicateParamName {
        module: String,
        function: String,
        param: String,
    },
    ReservedKeyword(String),
    InvalidIdentifier(String, &'static str),
    ErrorDomainMissingName(String),
    DuplicateErrorName {
        module: String,
        name: String,
    },
    DuplicateErrorCode {
        module: String,
        code: i32,
    },
    InvalidErrorCode {
        module: String,
        name: String,
    },
    NameCollisionWithErrorDomain {
        module: String,
        name: String,
    },
    AbiSymbolCollision {
        module: String,
        symbol: String,
    },
    ThrowsWithoutErrorDomain {
        module: String,
        function: String,
    },
    DuplicateTypeName {
        name: String,
        first: String,
        second: String,
    },
    DuplicateErrorCodeName {
        name: String,
        first: String,
        second: String,
    },
    DuplicateStructName {
        module: String,
        name: String,
    },
    DuplicateStructField {
        struct_name: String,
        field: String,
    },
    EmptyStruct {
        module: String,
        name: String,
    },
    DuplicateEnumName {
        module: String,
        name: String,
    },
    EmptyEnum {
        module: String,
        name: String,
    },
    DuplicateEnumVariant {
        enum_name: String,
        variant: String,
    },
    DuplicateEnumVariantField {
        enum_name: String,
        variant: String,
        field: String,
    },
    DuplicateEnumValue {
        enum_name: String,
        value: i32,
    },
    DuplicateInterfaceName {
        module: String,
        name: String,
    },
    DuplicateInterfaceMember {
        interface: String,
        name: String,
    },
    EmptyInterface {
        module: String,
        name: String,
    },
    ConstructorHasReturn {
        interface: String,
        constructor: String,
    },
    AsyncConstructor {
        interface: String,
        constructor: String,
    },
    InterfaceInInvalidPosition {
        name: String,
        location: String,
    },
    UnknownTypeRef {
        name: String,
    },
    InvalidMapKey {
        key_type: String,
    },
    BorrowedTypeInInvalidPosition {
        ty: String,
        location: String,
    },
    DuplicateCallbackName {
        module: String,
        name: String,
    },
    ListenerCallbackNotFound {
        module: String,
        listener: String,
        callback: String,
    },
    DuplicateListenerName {
        module: String,
        name: String,
    },
    UnsupportedCallbackParamType {
        module: String,
        callback: String,
        param: String,
        ty: String,
    },
    IteratorInInvalidPosition {
        location: String,
    },
    UnsupportedElementType {
        location: String,
        ty: String,
    },
    AsyncIteratorReturn {
        module: String,
        function: String,
    },
    BuilderStructEmpty {
        module: String,
        name: String,
    },
    UnsupportedSchemaVersion {
        version: String,
        supported: String,
    },
}

Every way an Api can fail validation.

validate_api collects every variant it encounters. Each variant carries the names needed to render an actionable diagnostic, and the #[error]/#[diagnostic] attributes supply the message and help text shown to the user.

Variants

NoModuleName

A module is missing its required name field.

DuplicateModuleName(String)

Two modules share the same name.

InvalidModuleName(String, &'static str)

A module name is not a valid identifier; the second field explains why.

DuplicateFunctionName

Two functions in the same module share a name.

Fields

module: String

Module that contains the colliding functions.

function: String

Duplicated function name.

DuplicateParamName

Two parameters of one function share a name.

Fields

module: String

Module that contains the function.

function: String

Function that contains the colliding parameters.

param: String

Duplicated parameter name.

ReservedKeyword(String)

A name matches a reserved keyword in one of the target languages.

InvalidIdentifier(String, &'static str)

An identifier is malformed; the second field explains why.

ErrorDomainMissingName(String)

An error domain in the named module is missing its name field.

DuplicateErrorName

Two error codes in the same module share a name.

Fields

module: String

Module that contains the error domain.

name: String

Duplicated error code name.

DuplicateErrorCode

Two error codes in the same module share a numeric value.

Fields

module: String

Module that contains the error domain.

code: i32

Conflicting numeric error code.

InvalidErrorCode

An error code uses a reserved value: 0 means success and -2 is the panic code the runtime reports when a producer panics.

Fields

module: String

Module that contains the error domain.

name: String

Error code name with the invalid value.

NameCollisionWithErrorDomain

A function name collides with an error domain name in the same module.

Fields

module: String

Module where the collision occurs.

name: String

Name shared by the function and the error domain.

AbiSymbolCollision

Two callables in one module lower to the same C symbol.

Free functions claim {prefix}_{module}_{name}; interface members claim {prefix}_{module}_{Interface}_{member} plus an implicit _destroy. A free function named Store_get and a get method on an interface Store would collide.

Fields

module: String

Module whose symbol namespace has the collision.

symbol: String

The colliding symbol suffix (without the {prefix}_{module}_ part).

ThrowsWithoutErrorDomain

A function declares throws: true but no error domain is in scope.

Fields

module: String

Module that contains the function.

function: String

Function marked throws with no domain in scope.

DuplicateTypeName

Two types (structs, enums, or interfaces) share a bare name.

Type names must be unique across the whole API: generators emit flat per-language type names, and unqualified cross-module references resolve by bare name, so two types called Config would collide in generated code and make references ambiguous.

Fields

name: String

The colliding bare type name.

first: String

Module path of the first declaration.

second: String

Module path of the second declaration.

DuplicateErrorCodeName

Two error domains declare a code with the same name.

Code names must be unique across every domain in the API: backends with flat namespaces (Python, Node, Go) derive one error class or constant per code, so NotFound in two domains would collide in generated code.

Fields

name: String

The colliding code name.

first: String

Domain of the first declaration, as module.Domain.

second: String

Domain of the second declaration, as module.Domain.

DuplicateStructName

Two structs in the same module share a name.

Fields

module: String

Module that contains the structs.

name: String

Duplicated struct name.

DuplicateStructField

Two fields of one struct share a name.

Fields

struct_name: String

Struct that contains the colliding fields.

field: String

Duplicated field name.

EmptyStruct

A struct declares no fields.

Fields

module: String

Module that contains the struct.

name: String

Name of the empty struct.

DuplicateEnumName

Two enums in the same module share a name.

Fields

module: String

Module that contains the enums.

name: String

Duplicated enum name.

EmptyEnum

An enum declares no variants.

Fields

module: String

Module that contains the enum.

name: String

Name of the empty enum.

DuplicateEnumVariant

Two variants of one enum share a name.

Fields

enum_name: String

Enum that contains the colliding variants.

variant: String

Duplicated variant name.

DuplicateEnumVariantField

Two associated fields of one rich enum variant share a name.

Fields

enum_name: String

Enum that contains the variant.

variant: String

Variant that contains the colliding fields.

field: String

Duplicated associated field name.

DuplicateEnumValue

Two variants of one enum share a numeric discriminant.

Fields

enum_name: String

Enum that contains the variants.

value: i32

Conflicting numeric discriminant.

DuplicateInterfaceName

Two interfaces in the same module share a name.

Fields

module: String

Module that contains the interfaces.

name: String

Duplicated interface name.

DuplicateInterfaceMember

Two members (constructors, methods, or statics) of one interface share a name.

Fields

interface: String

Interface that contains the colliding members.

name: String

Duplicated member name.

EmptyInterface

An interface declares no members at all.

Fields

module: String

Module that contains the interface.

name: String

Name of the empty interface.

ConstructorHasReturn

An interface constructor declares an explicit return type.

Fields

interface: String

Interface that declares the constructor.

constructor: String

The offending constructor.

AsyncConstructor

An interface constructor is marked async.

Fields

interface: String

Interface that declares the constructor.

constructor: String

The offending constructor.

InterfaceInInvalidPosition

An interface reference appears in a position the ABI cannot support.

Fields

name: String

The referenced interface name.

location: String

Position where the interface reference appeared.

UnknownTypeRef

A type reference names a struct, enum, or interface that doesn’t exist.

Fields

name: String

Unresolved type name.

InvalidMapKey

A map uses a key type the C ABI can’t represent.

Fields

key_type: String

Rejected key type, rendered as it appears in the IDL.

BorrowedTypeInInvalidPosition

A borrowed type appears somewhere other than a function parameter.

Fields

ty: String

Borrowed type that was rejected.

location: String

Position where the borrowed type appeared.

DuplicateCallbackName

Two callbacks in the same module share a name.

Fields

module: String

Module that contains the callbacks.

name: String

Duplicated callback name.

ListenerCallbackNotFound

A listener references a callback that isn’t defined in its module.

Fields

module: String

Module that contains the listener.

listener: String

Listener with the dangling reference.

callback: String

Callback name that could not be resolved.

DuplicateListenerName

Two listeners in the same module share a name.

Fields

module: String

Module that contains the listeners.

name: String

Duplicated listener name.

UnsupportedCallbackParamType

A callback parameter uses a type that can’t cross the callback ABI.

Fields

module: String

Module that contains the callback.

callback: String

Callback that declares the parameter.

param: String

Parameter with the unsupported type.

ty: String

Offending type, rendered as it appears in the IDL.

IteratorInInvalidPosition

An iterator type appears somewhere other than a function return.

Fields

location: String

Position where the iterator type appeared.

UnsupportedElementType

A list, map, or iterator has an element type the C ABI can’t flatten.

Fields

location: String

Position where the unsupported element type appeared.

ty: String

Offending element type, rendered as it appears in the IDL.

AsyncIteratorReturn

An async function tries to return an iterator, which has no async ABI.

Fields

module: String

Module that contains the function.

function: String

Async function with the iterator return.

BuilderStructEmpty

A struct marked builder: true declares no fields.

Fields

module: String

Module that contains the struct.

name: String

Name of the empty builder struct.

UnsupportedSchemaVersion

The document declares a schema version this build doesn’t support.

Fields

version: String

Version requested by the document.

supported: String

Comma-separated list of versions this build accepts.

Trait Implementations

impl Debug for ValidationError

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

Formats the value using the given formatter.

impl Diagnostic for ValidationError

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 code<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

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 severity(&self) -> Option<Severity>

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

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

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

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

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

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

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

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

Additional related Diagnostics.

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

The cause of the error.

impl Display for ValidationError

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

Formats the value using the given formatter.

impl Error for ValidationError

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.