Enum Error 

#[non_exhaustive]
pub enum Error {
    ArcCycle {
        path: Path,
        depth: usize,
    },
    UnresolvedLayer {
        asset_path: String,
        arc: ArcType,
        site_path: Path,
    },
    MissingDefaultPrim {
        layer_id: String,
        arc: ArcType,
        site_path: Path,
    },
    InvalidDefaultPrim {
        layer_id: String,
        arc: ArcType,
        site_path: Path,
    },
}

An error encountered while building a PrimIndex.

These errors represent recoverable composition failures — a missing layer or invalid metadata does not have to be fatal. The error handler provided via StageBuilder::on_error decides whether to skip the broken arc and continue, or abort.

Variants (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.

ArcCycle

A composition arc cycle was detected.

Fields

path: Path

The prim path where the cycle was detected.

depth: usize

Recursion depth when the cycle was detected.

UnresolvedLayer

A layer referenced by a composition arc was not found among loaded layers.

Fields

asset_path: String

The asset path that could not be matched.

arc: ArcType

The composition arc type that introduced this dependency.

site_path: Path

The prim path where the arc was authored.

MissingDefaultPrim

An external reference/payload targets a layer without specifying a prim path, but the target layer has no defaultPrim metadata.

Fields

layer_id: String

Identifier of the target layer.

arc: ArcType

The composition arc type.

site_path: Path

The prim path where the arc was authored.

InvalidDefaultPrim

The defaultPrim metadata on a target layer has an invalid or unexpected value.

Fields

layer_id: String

Identifier of the target layer.

arc: ArcType

The composition arc type.

site_path: Path

The prim path where the arc was authored.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 CompositionError

fn from(source: Error) -> Self

Converts to this type from the input type.