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),
}

Global error which encapsulates all related errors.

Variants

Validation(ValidationError)

Error encountered during spec validation.

Tuple Fields of Validation

0: ValidationError

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.

Tuple Fields of RelativePathNotUnique

0: String

MissingParametersInPath(String, HashSet<String>)

Tuple Fields of MissingParametersInPath

0: String1: HashSet<String>

InvalidHost(String, ParseError)

Invalid host for URL.

Tuple Fields of InvalidHost

0: String1: ParseError

InvalidBasePathURL(String, ParseError)

Invalid base path URL.

Tuple Fields of InvalidBasePathURL

0: String1: ParseError

MissingArrayItem(Option<String>)

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

Tuple Fields of MissingArrayItem

0: Option<String>

InvalidDefinitionName(String)

The name for the given definition is invalid.

Tuple Fields of InvalidDefinitionName

0: String

MissingDefinitionName

The name for the given definition is missing.

InvalidDefinitionPath(PathBuf)

A valid path cannot be obtained for the given definition.

Tuple Fields of InvalidDefinitionPath

0: PathBuf

Io(Error)

I/O errors.

Tuple Fields of Io

0: Error

Json(Error)

JSON coding errors.

Tuple Fields of Json

0: Error

Yaml(Error)

YAML coding errors.

Tuple Fields of Yaml

0: Error

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

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

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

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

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

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

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

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.