Enum paperclip::PaperClipError

pub enum PaperClipError {
    Validation(ValidationError),
    InvalidCodegenDirectory,
    UnsupportedOpenAPIVersion,
    RelativePathNotUnique(String),
    MissingParametersInPath(String, HashSet<String>),
    InvalidHost(String, ParseError),
    InvalidBasePathURL(String, ParseError),
    MissingArrayItem(Option<String>),
    InvalidDefinitionName(String),
    MissingDefinitionName,
    InvalidDefinitionPath(PathBuf),
    Io(Error),
    Json(Error),
    Yaml(Error),
    Templating(Error),
}

Global error which encapsulates all related errors.

Variants

Validation(ValidationError)

Error encountered during spec validation.

InvalidCodegenDirectory

The given directory cannot be used for generating code.

UnsupportedOpenAPIVersion

Currently, we only support OpenAPI v2, and eventually v3.

RelativePathNotUnique(String)

Paths listed in the spec must be unique.

MissingParametersInPath(String, HashSet<String>)

InvalidHost(String, ParseError)

Invalid host for URL.

InvalidBasePathURL(String, ParseError)

Invalid base path URL.

MissingArrayItem(Option<String>)

The given schema object is an array, but the items field is missing.

InvalidDefinitionName(String)

The name for the given definition is invalid.

MissingDefinitionName

The name for the given definition is missing.

InvalidDefinitionPath(PathBuf)

A valid path cannot be obtained for the given definition.

Io(Error)

I/O errors.

Json(Error)

JSON coding errors.

Yaml(Error)

YAML coding errors.

Templating(Error)

Errors in templating.

Trait Implementations

impl Debug for PaperClipError

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

Formats the value using the given formatter.

impl Display for PaperClipError

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

Formats the value using the given formatter.

impl Error for PaperClipError

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

The lower-level source of this error, if any.

pub fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

pub fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl From<Error> for PaperClipError

fn from(s: Error) -> Self

Performs the conversion.

impl From<Error> for PaperClipError

fn from(s: Error) -> Self

Performs the conversion.

impl From<Error> for PaperClipError

fn from(s: Error) -> Self

Performs the conversion.

impl From<Error> for PaperClipError

fn from(s: Error) -> Self

Performs the conversion.

impl From<ValidationError> for PaperClipError

fn from(s: ValidationError) -> Self

Performs the conversion.