Module contracts

Source

Modules§

backend
Open backend contract. Implementations live in separate crates.
cancel
Cooperative cancellation for long geometry operations.
capability
Backend identity metadata. Operation traits remain the sole capability truth.
capability_id
Stable, transport-independent capability identifiers.
error
Structured geometry failures suitable for fallback and diagnostics.
execution
Execution policy passed explicitly to every costly operation.
integration
Versioned, provider-neutral contracts for downstream capability discovery.
plan
Reproducible operation plans.
profiles
Normative v0.4 downstream integration profiles.

Structs§

ApiVersion
Semantic version of an integration API or ABI.
BackendDescriptor
Provider identity only. It deliberately contains no operation booleans.
BackendId
Stable provider identifier for logs and explicit selection.
BoundaryContract
Unit, coordinate, tolerance, ownership, and execution semantics.
CancellationToken
A shared cancellation flag.
CapabilityDescriptor
One capability backed by a concrete provider in this build.
CapabilityId
Versioned semantic operation identity, independent of providers and wire encoding.
CapabilityRequirement
Minimum behavior a caller needs before it submits geometry.
DataResidency
Where an operation’s inputs live and where its outputs are wanted.
EscalationLadder
The precision tiers a filtered predicate steps through, weakest first.
ExecutionOptions
Operation policy with explicit tolerance, precision, and cancellation.
IntegrationDescriptor
Complete handshake returned by one compiled integration surface.
Plan
A reproducible operation plan.
PlanStep
One recorded step: what ran, where, and under what guarantee.
ProfileContract
Compatibility promise for one supported way of consuming Axiolid.

Enums§

CancellationGranularity
How finely a provider polls its cancellation token.
Certified
A predicate evaluation that may or may not be trustworthy.
Determinism
Reproducibility requirement.
DevicePreference
Device selection preference. Auto is a policy request, not permission to silently reduce precision.
Exactness
Fidelity a capability promises for its output.
ExecutionTarget
Broad execution target. Specific ISA/device features stay in provider crates.
GeomError
Why a backend-neutral geometry operation failed.
IntegrationProfile
Supported way an application reaches Axiolid.
Operation
Operation name used for diagnostics only. Implementing an operation trait is the capability proof; this enum never drives capability discovery.
OutputBound
Upper bound on how many outputs an operation produces per input element.
Ownership
Cross-boundary ownership model.
Parallelism
CPU scheduling preference.
Precision
Arithmetic precision accepted or required by an operation.
Representation
Portable representation families visible at an integration boundary.
RequirementRefusal
Typed reason a capability handshake refused a request.
Residency
Where an operation’s data physically lives.
ScratchRequirement
Scratch memory an operation needs beyond its inputs and outputs.
Sign
The sign of a geometric predicate, with its trustworthiness attached.
ThreadSafety
Thread-safety promise of one integration profile.

Constants§

INTEGRATION_API_VERSION
First downstream integration protocol shipped by Axiolid.
MINIMUM_RUST_VERSION
Minimum supported Rust compiler for Rust integration profiles.
V04_PROFILE_CONTRACTS
Profiles supported by the v0.4 integration protocol.

Traits§

Backend
Runtime geometry backend metadata.

Type Aliases§

GeomResult
Result alias for geometry operations.