Enum BuildError 

#[non_exhaustive]
pub enum BuildError {
    VirtualManifest(PathBuf),
    General(String),
    BuildRustdocJsonError,
    CapturedOutputError(String),
    CommandExecutionError(String),
    CargoManifestError(Error),
    CargoMetadataError(Error),
    IoError(Error),
}

Represents all errors that can occur when using Builder::build().

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.

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.

BuildRustdocJsonError

An error originating from building the rustdoc JSON for a crate.

In this case the user will see the exact errors on stderr, regardless of if stderr was printed to the terminal or captured with Builder::build_with_captured_output().

CapturedOutputError(String)

Occurs when stdout or stderr could not be captured when using Builder::build_with_captured_output()).

CommandExecutionError(String)

Occurs when a command could not be executed, e.g. because the binary that we tried to run did not exist.

CargoManifestError(Error)

An error originating from cargo-manifest.

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

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