docs: add cpex Rust specification#50
Merged
Merged
Conversation
monshri
pushed a commit
to monshri/contextforge-plugins-framework
that referenced
this pull request
May 27, 2026
Co-authored-by: Teryl Taylor <terylt@ibm.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds the public API spec for CPEX's Rust core (
cpex-core+cpex-sdk). Companion document tocpex-go-spec.md, but covering the in-process Rust path: how to author a plugin, how to embedthe manager, and what the framework guarantees.
Audience
PluginManagerinto a Rust application.(Go integrators should keep using
cpex-go-spec.md— that doc covers the C ABI surface, this one covers the typedRust API one layer below it.)
What's covered
PluginManager, the registry, and the executor fit together.Plugin,HookHandler<H>,HookTypeDef, andPluginPayloadtraits, with the borrow /clone / capability semantics spelled out.
hypothetical Rust
cdylib) work without changing the typed plugin-author API. Marked clearly as design-only wherethings aren't shipped yet.
What this is not
but not specified.
cpex-go-spec.md.Review focus
cdylibpath is design-only?
Test plan
§N) resolvecrates/cpex-coresymbols (spot-checkregister_handler,HookTypeDef,define_hook!,PluginResultconstructors)