The API reference is generated by Rustdoc directly from the public 0.1.0 sources. It provides searchable public modules, structures, enums, traits, functions and methods, with signatures and their documentation, associated types, errors and Safety contracts.
The versioned API website provides direct HTML navigation and search.
The four crate indexes below are relative to 0.1.0/api/:
| Crate | HTML entry | Content |
|---|---|---|
fe11 | fe11/index.html | High-level PKCS#11 API and resource owners |
fe11-sys | fe11_sys/index.html | Raw constants, C types and function tables |
fe11-verify-engine-api | fe11_verify_engine_api/index.html | Verification-component ABI, requests and callbacks |
fe11-verify-engine | fe11_verify_engine/index.html | Component discovery entry point |
| Area | Starting declarations |
|---|---|
| Module loading and discovery | Module, ModuleBuilder, InterfaceInventory, ModuleProvenance |
| Initialization and shared use | InitializationOptions, NativeConcurrency, RuntimeOwner |
| Sessions and authentication | Session, AdvancedSession, SecretPin |
| Native objects and creation | NativeObjectRef, ManagedObjectRef, CreatedObjects |
| Attributes and observations | StandardAttribute, ObjectObservationPlan, MechanismObservationPlan |
| Resource admission | ResourceAdmission, SessionAdmission, AdmissionCancellation |
| Results and diagnostics | Error, RejectionReason, BusyReason, UnsupportedReason |
| Recovery and persistence | ModuleDrain, RecordLimits, StreamProgress |
| Software verification | VerifyEngine, VerifyEngineBuilder, VerifyEngineInfo |
Use Rustdoc’s search for a declaration or method name. Type pages group methods and trait implementations; source links open the corresponding public Rust source. The API guide explains workflows, while usage contracts and coexistence cover cross-cutting behavior.
From the Fe11 workspace, with dependencies resolved:
cargo doc -p fe11 -p fe11-verify-engine-api --no-depsFrom the Fe11-sys repository:
cargo doc --no-depsFor the engine, configure the native build prerequisites, then run:
cargo doc -p fe11-verify-engine --no-depsCargo writes each crate’s reference under target/doc. Documentation builds process public source declarations and dependency/build prerequisites. The distributed reference is generated for Windows x86_64 MSVC; the platform profiles specify the corresponding Linux and Windows ABI layouts.