Enum DocError 

#[non_exhaustive]
pub enum DocError {
    FileReadError(Error),
    CommentError(CommentError),
    SqlParserError(ParserError),
    InvalidObjectName {
        message: String,
        line: u64,
        column: u64,
    },
    TableNotFound {
        name: String,
    },
    ColumnNotFound {
        name: String,
    },
    DuplicateTablesFound {
        tables: Vec<TableDoc>,
    },
    DuplicateColumnsFound {
        columns: Vec<ColumnDoc>,
    },
    TableWithSchemaNotFound {
        name: String,
        schema: String,
    },
}

Errors that can occur while discovering, parsing, or documenting SQL files.

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.

FileReadError(Error)

Wrapper for standard std::io::Error

CommentError(CommentError)

Wrapper for CommentError

SqlParserError(ParserError)

Wrapper for ParserError

InvalidObjectName

Indicates an invalid or unexpected object name in the sqlparser::ast::Statement

Fields

message: String

The message to accompany the invalid sqlparser::ast::ObjectName

line: u64

The line number for the invalid sqlparser::ast::ObjectName

column: u64

The column number for the invalid sqlparser::ast::ObjectName

TableNotFound

Table not found when searching crate::SqlDoc

Fields

name: String

The name of the table that was not found

ColumnNotFound

Column not found when searching crate::docs::TableDoc

Fields

name: String

The name of the column not found

DuplicateTablesFound

Duplicate tables with same name were found when searching crate::SqlDoc

Fields

tables: Vec<TableDoc>

Vec of the TableDoc for each duplicate table found

DuplicateColumnsFound

Duplicate columns with same name were found when searching a single TableDoc

Fields

columns: Vec<ColumnDoc>

Vec of the crate::docs::ColumnDoc for each duplicate table found

TableWithSchemaNotFound

Could not find table with schema

Fields

name: String

the name of the table not found

schema: String

the schema for the table not found

Trait Implementations

impl Debug for DocError

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

Formats the value using the given formatter.

impl Display for DocError

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

Formats the value using the given formatter.

impl Error for DocError

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<CommentError> for DocError

fn from(e: CommentError) -> Self

Converts to this type from the input type.

impl From<Error> for DocError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<ParserError> for DocError

fn from(e: ParserError) -> Self

Converts to this type from the input type.