Struct DocError 

pub struct DocError { /* private fields */ }

Errors that can occur while generating documentation.

Implementations

impl DocError

pub fn new(kind: DocErrorKind) -> Self

Create a new DocError.

pub fn kind(&self) -> &DocErrorKind

The kind of error that occurred.

pub fn with_context(self, context: impl Display) -> Self

Add a context message to this error.

Trait Implementations

impl Debug for DocError

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

Formats the value using the given formatter.

impl Display for DocError

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

Formats the value using the given formatter.

impl Error for DocError

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<DocErrorKind> for DocError

fn from(e: DocErrorKind) -> Self

Converts to this type from the input type.

impl From<Error> for DocError

fn from(e: IoError) -> Self

Converts to this type from the input type.

impl From<NpmError> for DocError

fn from(e: NpmError) -> Self

Converts to this type from the input type.