Enum rustdoc_json::BuildError

pub enum BuildError {
    VirtualManifest(PathBuf),
    General(String),
    CargoTomlError(Error),
    CargoMetadataError(Error),
    IoError(Error),
}

Represent all errors that can occur when using build() and build_quietly().

Variants

VirtualManifest(PathBuf)

You tried to generate rustdoc JSON for a virtual manifest. That does not work. You need to point to the manifest of a real package.

General(String)

A general error. Refer to the attached error message for more info.

CargoTomlError(Error)

An error originating from cargo_toml.

CargoMetadataError(Error)

An error originating from cargo_metadata.

IoError(Error)

Some kind of IO error occurred.

Trait Implementations

impl Debug for BuildError

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

Formats the value using the given formatter.

impl Display for BuildError

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

Formats the value using the given formatter.

impl Error for BuildError

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 BuildError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for BuildError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for BuildError

fn from(source: Error) -> Self

Converts to this type from the input type.