Struct PlanError 

pub struct PlanError { /* private fields */ }

How planning says no.

Planning issues are independent and co-establishable — one pass may find a doubled seat and an overrun magnitude at once — so the body carries every issue the pass established, and says so where it kept only what fits. No issue is elected as the primary one, and a body with nothing in it is unrepresentable.

Implementations

impl PlanError

pub fn of(issue: PlanIssue) -> Self

The refusal one established issue makes.

pub fn over(first: PlanIssue, rest: Vec<PlanIssue>) -> Self

The refusal a pass whose checks co-establish makes.

The caller arrives holding every issue its pass established, so the posture the body writes is about the REPORT and never about the pass: where the issues fit it carries all of them, and where they do not it carries what fits and counts the rest.

pub fn bounded(axis: BoundAxis, overflow: Overflow) -> Self

The refusal a magnitude makes: the axis that was overrun, and the two counts the overflow already carries.

pub fn over_trail(node: Identity<GeneratedUnit>, refusal: TrailError) -> Self

The refusal a trail that could not be drawn makes, over the unit it was to be drawn for.

The unit is the caller’s to name because a trail refusal carries none, and an origin that cannot be drawn at all is that unit standing with no origin.

pub fn first_issue(&self) -> &PlanIssue

The first issue the pass established, which every refusal has.

pub fn issues(&self) -> &NonEmpty<PlanIssue, PLAN_ISSUE_LIMIT>

Every issue this refusal carries, in the order the pass established them; structurally at least one.

pub const fn capping(&self) -> Capping

Whether this refusal carries every issue its pass established.

Trait Implementations

impl Clone for PlanError

fn clone(&self) -> PlanError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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, into: &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 Hash for PlanError

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for PlanError

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

Equality operator ==.

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

Inequality operator !=.

impl Refused for PlanError

fn related(&self) -> Vec<Vec<u8>>

The issues established beyond the primary cause; the primary is the summary’s own subject, never a member of its related set.

fn repairs(&self) -> Bounded<Repair, REPAIR_LIMIT>

This home declares no repair of its own.

Every issue above is about what the caller’s own declaration states, so the repair is that declaration; a sentence composed here would be this compiler citing a fact nobody declared.

const PHASE: Phase = Phase::Planning

The step of the road this refusal is raised at.

const FAMILY: Family = PLANNING_FAMILY

The family whose issue space this refusal’s related identities derive in.

fn class(&self) -> RefusalClass

Which class of refusal the summary line opens with.

fn first(&self) -> String

How the first established issue reads for a person.

fn observed(&self) -> Observed

How what was observed differs from the expected contract, read off that same first issue.

fn body(&self) -> LineBody

What the summary line is a summary of.

impl StructuralPartialEq for PlanError