Enum Error

pub enum Error {
    MissingVersionInUrl(String),
    NonFirstTopLevelHeader(String),
    UnrecognizedUrl(String),
    WrongCrateNameInUrl(String),
    WrongVersionInUrl(String),
}

Error returned by rustdocify.

Variants

MissingVersionInUrl(String)

Version was given to rustdocify but URL is missing a version.

Example

[foo]: https://docs.rs/foo

NonFirstTopLevelHeader(String)

Readme has top-level header that is not first header.

Example

### First
## Second

UnrecognizedUrl(String)

URL is not recognized as valid.

This means that either URL is invalid or this crate has a bug.

Example

[foo]: https://docs.rs/foo/*/foo/hello_world.html

WrongCrateNameInUrl(String)

Crate name was given to rustdocify but URL has different crate name.

Example

[foo]: https://docs.rs/foo/*/DIFFERENT_CRATE

WrongVersionInUrl(String)

Version was given to rustdocify but URL has different version.

Example

[foo]: https://docs.rs/foo/DIFFERENT_VERSION

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 PartialEq for Error

fn eq(&self, other: &Error) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Error