Enum ApplyApiError 

#[non_exhaustive]
pub enum ApplyApiError {
    PrimNotValid {
        path: Path,
    },
    Composition(QueryError),
    NotAppliedApi {
        schema: Token,
    },
    MissingInstanceName {
        schema: Token,
    },
    UnexpectedInstanceName {
        schema: Token,
        instance: Token,
    },
    InstanceNameNotAllowed {
        schema: Token,
        instance: Token,
    },
    PrimTypeNotAllowed {
        schema: Token,
        allowed: Vec<Token>,
    },
}

Why an API schema cannot be applied to a prim — the reason C++ UsdPrim::CanApplyAPI reports through its whyNot.

Apart from PrimNotValid, every variant names a registered schema: a name no registry knows carries no rules to break, so applying it is accepted (see Prim::apply_api).

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.

PrimNotValid

No prim is composed at the path, so there is nothing to apply to.

Fields

path: Path

The path that composed no prim.

Composition(QueryError)

Deciding the question needed the prim’s composed type, and composing it failed.

NotAppliedApi

The schema is registered, but is not one that applies to a prim through apiSchemas — a typed schema, or a non-applied API schema.

Fields

schema: Token

The offending schema identifier.

MissingInstanceName

A multiple-apply schema applies per instance, so it needs an instance name (CollectionAPI:render).

Fields

schema: Token

The offending schema identifier.

UnexpectedInstanceName

A single-apply schema applies whole, so it has no instance to name.

Fields

schema: Token

The offending schema identifier.

instance: Token

The instance name that was supplied anyway.

InstanceNameNotAllowed

The schema restricts its instance names, or the name collides with one of the schema’s own property base names.

Fields

schema: Token

The offending schema identifier.

instance: Token

The rejected instance name.

PrimTypeNotAllowed

The schema’s apiSchemaCanOnlyApplyTo does not cover this prim’s type.

Fields

schema: Token

The offending schema identifier.

allowed: Vec<Token>

The prim types the schema restricts itself to.

Trait Implementations

impl Debug for ApplyApiError

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

Formats the value using the given formatter.

impl Display for ApplyApiError

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

Formats the value using the given formatter.

impl Error for ApplyApiError

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<ApplyApiError> for Error

fn from(source: ApplyApiError) -> Self

Converts to this type from the input type.

impl From<ApplyApiError> for StageAuthoringError

fn from(source: ApplyApiError) -> Self

Converts to this type from the input type.

impl From<QueryError> for ApplyApiError

fn from(source: QueryError) -> Self

Converts to this type from the input type.