Struct PlanError 

pub struct PlanError { /* private fields */ }

A stable planning failure with a validated logical path and no filesystem payload.

Implementations

impl PlanError

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

Returns the stable BXW#### code.

pub fn path(&self) -> &RelativePath

Returns the validated workspace-relative location of the failure.

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

Returns the stable rule detail.

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

Returns the normative source of the planning rule.

pub fn render_json(&self) -> String

Renders canonical boxology.plan-error@1 JSON.

pub fn is_unknown_package(&self) -> bool

Returns whether this is the invocation-level unknown-package failure.

Trait Implementations

impl Debug for PlanError

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

Formats the value using the given formatter.

impl Display for PlanError

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

Formats the value using the given formatter.

impl Eq for PlanError

impl Error for PlanError

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<PlanError> for CompareStepError

fn from(error: PlanError) -> Self

Converts to this type from the input type.

impl PartialEq for PlanError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PlanError