Skip to main content

GraphError

Enum GraphError 

Source
#[non_exhaustive]
pub enum GraphError {
Show 15 variants EmptyGraph, NodeNotFound(usize), CycleDetected, SubgraphCycle, SubgraphNotFound(usize), ArenaOom, BuilderFailed, ExceedsMaxNodes { count: usize, max: usize, }, ExceedsMaxLevels { depth: usize, max: usize, }, ExceedsMaxExtent { extent: usize, max: usize, }, RenderPlanOom, RenderCanvasTooSmall { needed: usize, got: usize, }, RenderOutputTooSmall, RenderWorkspaceTooSmall { needed_bytes: usize, got_bytes: usize, }, RenderSinkFailed,
}
Expand description

Unified error type for all graph and layout operations.

Each variant carries a WDP error code accessible via GraphError::code(), and an actionable hint via GraphError::hint().

§WDP Code Mapping

VariantWDP CodeMeaning
EmptyGraphE.Graph.Node.001MISSING — no nodes
NodeNotFoundE.Graph.Node.021NOT_FOUND — node absent
CycleDetectedE.Graph.Dag.003INVALID — DAG constraint violated
SubgraphCycleE.Graph.Subgraph.003INVALID — nesting cycle
SubgraphNotFoundE.Graph.Subgraph.021NOT_FOUND — subgraph absent
ArenaOomE.ArenaLayout.Alloc.026EXHAUSTED — arena memory
BuilderFailedE.ArenaLayout.Builder.026EXHAUSTED — builder alloc
ExceedsMaxNodesE.ArenaLayout.Node.004OVERFLOW — index type full
ExceedsMaxLevelsE.ArenaLayout.Level.004OVERFLOW — too deep
ExceedsMaxExtentE.ArenaLayout.Extent.004OVERFLOW — canvas past the coordinate type
RenderPlanOomE.Render.Plan.026EXHAUSTED — plan buffer
RenderCanvasTooSmallE.Render.Canvas.026EXHAUSTED — band buffer
RenderOutputTooSmallE.Render.Sink.026EXHAUSTED — output buffer
RenderWorkspaceTooSmallE.Render.Workspace.026EXHAUSTED — composer workspace
RenderSinkFailedE.Render.Sink.032FAILED — caller’s writer errored

§Examples

use ascii_dag::GraphError;

let err = GraphError::EmptyGraph;
assert_eq!(err.code(), "E.Graph.Node.001");
assert!(!err.hint().is_empty());

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

EmptyGraph

The graph has no nodes.

WDP: E.Graph.Node.001 (MISSING)

§

NodeNotFound(usize)

A referenced node ID does not exist in the graph.

WDP: E.Graph.Node.021 (NOT_FOUND)

§

CycleDetected

The graph contains a cycle but acyclicity was required.

WDP: E.Graph.Dag.003 (INVALID)

§

SubgraphCycle

Subgraph nesting would create a cycle in the hierarchy.

WDP: E.Graph.Subgraph.003 (INVALID)

§

SubgraphNotFound(usize)

A referenced subgraph ID does not exist.

WDP: E.Graph.Subgraph.021 (NOT_FOUND)

§

ArenaOom

The arena allocator ran out of memory.

WDP: E.ArenaLayout.Alloc.026 (EXHAUSTED)

Use Graph::estimate_layout_arena_size() to compute the required size.

§

BuilderFailed

The IR builder failed to allocate output structures.

WDP: E.ArenaLayout.Builder.026 (EXHAUSTED)

§

ExceedsMaxNodes

The graph has more nodes or edges than the selected index type supports.

WDP: E.ArenaLayout.Node.004 (OVERFLOW)

Fields

§count: usize

Actual node or edge count.

§max: usize

Maximum supported by the current index type.

§

ExceedsMaxLevels

The graph’s longest path exceeds the maximum level depth.

WDP: E.ArenaLayout.Level.004 (OVERFLOW)

Fields

§depth: usize

Actual depth of the longest path.

§max: usize

Maximum supported levels.

§

ExceedsMaxExtent

The layout’s cross-axis extent — its packed nodes plus the cells port routing opens beside them — exceeds the arena coordinate type.

WDP: E.ArenaLayout.Extent.004 (OVERFLOW)

Fields

§extent: usize

The extent the layout needs.

§max: usize

Maximum representable by the coordinate type.

§

RenderPlanOom

The caller-provided render-plan buffer is too small.

WDP: E.Render.Plan.026 (EXHAUSTED)

Use estimate_render_arena_size() to compute the required size.

§

RenderCanvasTooSmall

The caller-provided band buffer holds fewer than width × band_rows cells.

WDP: E.Render.Canvas.026 (EXHAUSTED)

Fields

§needed: usize

Cells required (width × band_rows).

§got: usize

Cells provided.

§

RenderOutputTooSmall

The caller-provided output byte buffer filled up mid-render.

WDP: E.Render.Sink.026 (EXHAUSTED)

§

RenderWorkspaceTooSmall

A fixed composer workspace cannot hold this scene’s composition. Units are BYTES — explicit in the field names so they can never be confused with the cell counts of RenderCanvasTooSmall.

WDP: E.Render.Workspace.026 (EXHAUSTED)

Fields

§needed_bytes: usize

Bytes the composition needs (usize::MAX: the requirement itself overflowed — the scene cannot fit any workspace).

§got_bytes: usize

Bytes the workspace holds.

§

RenderSinkFailed

The caller’s fmt::Write sink reported an error mid-render. The failure originated downstream of the renderer (the writer itself); rendering state is unaffected and the render may be retried with a healthy sink. Previously a writer failure could only surface as a bare fmt::Error with no code.

WDP: E.Render.Sink.032 (FAILED)

Implementations§

Source§

impl GraphError

Source

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

WDP Level 0 error code.

Format: Severity.Component.Primary.Sequence

Every variant maps to a unique code — no two variants share the same Component.Primary.Sequence triple.

Source

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

Actionable hint for resolving this error.

Trait Implementations§

Source§

impl Clone for GraphError

Source§

fn clone(&self) -> GraphError

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GraphError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for GraphError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for GraphError

Source§

impl Error for GraphError

Available on crate feature std only.
1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more
Source§

impl From<GraphError> for ErrorChain

Available on crate feature alloc only.
Source§

fn from(error: GraphError) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for GraphError

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl ProjectedFailure for GraphError

Source§

fn cause(&self) -> Option<&Self>

The next cause beneath this failure, if any.
Source§

impl StructuralPartialEq for GraphError

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.