Skip to main content

GenerateError

Enum GenerateError 

Source
#[non_exhaustive]
pub enum GenerateError {
Show 18 variants Read { path: PathBuf, source: Error, }, Write { path: PathBuf, source: Error, }, Overlay { path: PathBuf, source: OverlayError, }, Yaml(Error), Unusable(LoadError), NotOpenApi(Error), Schema { name: String, source: Error, }, Typify(Error), NoType { schema: String, }, OneType { first: String, second: String, rust: String, }, Unsupported(String), Operation { op: String, source: Box<GenerateError>, }, NotRust { file: &'static str, source: Error, }, Blob(DocumentError), RoundTrip, RustfmtMissing, RustfmtSpawn { path: PathBuf, source: Error, }, RustfmtFailed { path: PathBuf, },
}
Expand description

Why a bless step stopped.

Most variants are the document saying something this generator has no Rust spelling for; the rest are the two documents, the filesystem, or rustfmt. A bless step reports and exits, so nothing here is meant to be branched on — it is meant to name the thing to go and fix.

Variants (Non-exhaustive)§

This enum is marked as 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.
§

Read

Fields

§path: PathBuf
§source: Error
§

Write

Fields

§path: PathBuf
§source: Error
§

Overlay

A document or a layer over it that does not read, or does not apply. path is the file to go and open: with corrections split across layers, which one stopped the bless is the first thing to know.

Fields

§path: PathBuf
§

Yaml(Error)

§

Unusable(LoadError)

§

NotOpenApi(Error)

§

Schema

Fields

§name: String
§source: Error
§

Typify(Error)

§

NoType

A wrapper would have to name the type of a schema the document’s components.schemas never declared. Emitting an identifier for it anyway is how an adopter ends up bisecting a generated file, so the reference is named here instead.

Fields

§schema: String
§

OneType

Two of the document’s schemas reduce to one Rust type. typify writes a definition per schema and uniquifies nothing, so emitting them is a file that defines the same type twice; renaming one here would be a generator choosing a public name nobody asked for.

Fields

§first: String
§second: String
§rust: String
§

Unsupported(String)

§

Operation

A failure while emitting one operation’s wrapper, named by the operation it came from. Everything else this crate refuses says which operation it is about, and a generated file is too large to bisect by hand for one that does not.

Fields

§

NotRust

Fields

§file: &'static str
§source: Error
§

Blob(DocumentError)

§

RoundTrip

§

RustfmtMissing

§

RustfmtSpawn

Fields

§path: PathBuf
§source: Error
§

RustfmtFailed

Fields

§path: PathBuf

Trait Implementations§

Source§

impl Debug for GenerateError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for GenerateError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for GenerateError

Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.