Struct CargoAllowError 

pub struct CargoAllowError { /* private fields */ }

The unified error type for the cargo-allow workspace.

Carries a structured CargoAllowErrorKind, a human-readable message, and an optional cause chain (rendered as a caused by: suffix in Display). The kind() accessor lets programmatic consumers branch on error class without string-matching.

Implementations

impl CargoAllowError

pub fn new(message: impl Into<String>) -> Self

Create an error with CargoAllowErrorKind::Unknown (backward compat).

pub fn with_kind(kind: CargoAllowErrorKind, message: impl Into<String>) -> Self

Create an error with a structured kind.

pub fn with_kind_preserving_metadata(self, kind: CargoAllowErrorKind) -> Self

Reclassify an existing error without discarding its structured metadata.

Aggregation and adapter layers should use this when the surrounding contract provides a more precise kind. Rebuilding with Self::with_kind would lose locations, diagnostics, and causes.

pub fn with_cause(self, cause: &(impl Error + ?Sized)) -> Self

Attach a cause (underlying error) to this error, returning a new value.

The cause is rendered as a caused by: line in Display and linked for std::error::Error::source walks.

pub fn with_message_prefix(self, prefix: impl AsRef<str>) -> Self

Prefix the human-readable message without discarding structured error metadata such as the kind, source location, diagnostics, or causes.

Context layers should use this instead of rebuilding an error from its rendered string. Rebuilding loses information that machine consumers and editor integrations rely on.

pub fn with_message_suffix(self, suffix: impl AsRef<str>) -> Self

Append a message suffix without discarding structured error metadata.

Context layers should use this when adding remediation guidance after an existing message. Rebuilding an error from its rendered string loses metadata that machine consumers and editor integrations rely on.

pub fn causes(&self) -> &[String]

Rendered cause messages in attachment order (outermost first).

pub fn with_diagnostic(self, diagnostic: CargoAllowDiagnostic) -> Self

Attach one structured diagnostic detail, returning a new value.

pub fn with_diagnostics( self, diagnostics: impl IntoIterator<Item = CargoAllowDiagnostic>, ) -> Self

Attach multiple structured diagnostic details, returning a new value.

pub fn diagnostics(&self) -> &[CargoAllowDiagnostic]

Machine-readable details associated with this error.

pub fn kind(&self) -> CargoAllowErrorKind

The structured error kind.

pub fn code(&self) -> &'static str

The stable machine-readable code for this error.

pub fn with_toml_span( self, path: Option<&Path>, source: &str, span: Option<Range<usize>>, ) -> Self

Attach a one-based source location derived from a TOML byte span.

TOML reports byte offsets. This conversion keeps the public error contract independent of the parser’s error-display text and reports a character column suitable for editor and CI diagnostics.

pub fn location(&self) -> Option<&CargoAllowErrorLocation>

Structured source location, when the error originated from located input such as a TOML parse.

pub fn message(&self) -> &str

The human-readable message (without the cause chain).

Trait Implementations

impl Clone for CargoAllowError

fn clone(&self) -> CargoAllowError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CargoAllowError

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

Formats the value using the given formatter.

impl Display for CargoAllowError

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

Formats the value using the given formatter.

impl Error for CargoAllowError

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 CargoAllowError

Auto-convert io::Error so ? works at IO call sites without manual map_err. The kind is CargoAllowErrorKind::Unknown; callers that want a specific kind (e.g. Inventory) should use with_kind explicitly.

fn from(e: Error) -> Self

Converts to this type from the input type.