Enum SchemaError 

pub enum SchemaError {
    IoError {
        path: String,
        source: Error,
    },
    SyntaxError {
        src: String,
        span: SourceSpan,
        message: String,
    },
    InvalidModel {
        name: String,
        message: String,
    },
    InvalidField {
        model: String,
        field: String,
        message: String,
    },
    InvalidRelation {
        model: String,
        field: String,
        message: String,
    },
    Duplicate {
        kind: String,
        name: String,
    },
    UnknownType {
        model: String,
        field: String,
        type_name: String,
    },
    InvalidAttribute {
        attribute: String,
        message: String,
    },
    MissingId {
        model: String,
    },
    ConfigError {
        message: String,
    },
    TomlError {
        source: Error,
    },
    ValidationFailed {
        count: usize,
        errors: Vec<SchemaError>,
    },
    MissingVectorDimension {
        field: String,
    },
    InvalidVectorType {
        value: String,
    },
    InvalidVectorMetric {
        value: String,
    },
    InvalidVectorIndex {
        value: String,
    },
}

Errors that can occur during schema parsing and validation.

Variants

IoError

Error reading a file.

Fields

path: String

source: Error

SyntaxError

Syntax error in the schema file.

Fields

src: String

span: SourceSpan

message: String

InvalidModel

Invalid model definition.

Fields

name: String

message: String

InvalidField

Invalid field definition.

Fields

model: String

field: String

message: String

InvalidRelation

Invalid relation definition.

Fields

model: String

field: String

message: String

Duplicate

Duplicate definition.

Fields

kind: String

name: String

UnknownType

Unknown type reference.

Fields

model: String

field: String

type_name: String

InvalidAttribute

Invalid attribute.

Fields

attribute: String

message: String

MissingId

Missing required attribute.

Fields

model: String

ConfigError

Configuration error.

Fields

message: String

TomlError

TOML parsing error.

Fields

source: Error

ValidationFailed

Validation error with multiple issues.

Fields

count: usize

errors: Vec<SchemaError>

MissingVectorDimension

A Vector field is missing a required @dim(N) attribute.

Fields

field: String

Field name.

InvalidVectorType

A Vector field has an invalid @vectorType value.

Fields

value: String

Supplied type value.

InvalidVectorMetric

A Vector field has an invalid @metric value.

Fields

value: String

Supplied metric value.

InvalidVectorIndex

A Vector field has an invalid @index value.

Fields

value: String

Supplied index value.

Implementations

impl SchemaError

pub fn syntax( src: impl Into<String>, offset: usize, len: usize, message: impl Into<String>, ) -> SchemaError

Create a syntax error with source location.

pub fn invalid_model( name: impl Into<String>, message: impl Into<String>, ) -> SchemaError

Create an invalid model error.

pub fn invalid_field( model: impl Into<String>, field: impl Into<String>, message: impl Into<String>, ) -> SchemaError

Create an invalid field error.

pub fn invalid_relation( model: impl Into<String>, field: impl Into<String>, message: impl Into<String>, ) -> SchemaError

Create an invalid relation error.

pub fn duplicate( kind: impl Into<String>, name: impl Into<String>, ) -> SchemaError

Create a duplicate definition error.

pub fn unknown_type( model: impl Into<String>, field: impl Into<String>, type_name: impl Into<String>, ) -> SchemaError

Create an unknown type error.

Trait Implementations

impl Debug for SchemaError

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

Formats the value using the given formatter.

impl Diagnostic for SchemaError

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

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

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

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

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

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 SchemaError

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

Formats the value using the given formatter.

impl Error for SchemaError

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.