Type Alias ApiError 

pub type ApiError = Error;

Public alias for the boxddd error type.

Aliased Type

pub enum ApiError {
    InCallback,
    CreateWorldFailed,
    CreateBodyFailed,
    CreateShapeFailed,
    CreateRecordingFailed,
    CreateDynamicTreeFailed,
    CreateRecPlayerFailed,
    RecordingIoFailed,
    InvalidArgument,
    InvalidWorldId,
    InvalidBodyId,
    InvalidShapeId,
    InvalidJointId,
    InvalidContactId,
    WrongJointType,
    IndexOutOfRange,
    NulByteInString,
    ResourceLifetimeViolation,
    UnsupportedOnWasm,
    CallbackPanicked,
    CallbackSlotsExhausted,
    ProviderCallbackFailed,
}

Variants

InCallback

The operation was attempted while Box3D was executing a callback.

CreateWorldFailed

Box3D did not return a valid world id.

CreateBodyFailed

Box3D did not return a valid body id.

CreateShapeFailed

Box3D did not return a valid shape id.

CreateRecordingFailed

Box3D did not return a valid recording handle.

CreateDynamicTreeFailed

Box3D did not return a valid dynamic tree handle.

CreateRecPlayerFailed

Box3D did not return a valid replay player handle.

RecordingIoFailed

A native recording file operation failed.

InvalidArgument

An input value failed validation.

InvalidWorldId

The world handle failed Box3D id validation.

InvalidBodyId

The body handle failed Box3D id validation.

InvalidShapeId

The shape handle failed Box3D id validation.

InvalidJointId

The joint handle failed Box3D id validation.

InvalidContactId

The contact handle failed Box3D id validation.

WrongJointType

A joint-specific API was called with a different joint type.

IndexOutOfRange

The provided index is outside the range accepted by the native API.

NulByteInString

A string passed to Box3D contained an interior NUL byte.

ResourceLifetimeViolation

A native resource would outlive the resource it depends on.

UnsupportedOnWasm

The operation is unavailable for the current WebAssembly backend.

CallbackPanicked

A Rust callback panicked and boxddd stopped the native traversal safely.

CallbackSlotsExhausted

All global callback slots are currently in use.

ProviderCallbackFailed

A provider-mode callback bridge failed while collecting debug draw data.