Skip to content

Rust SDK (binoc-sdk)

The canonical Rust API reference is the rustdoc output for the binoc-sdk crate, served on this site as a static subpath:

Browse the binoc_sdk rustdoc ā†’

It is regenerated from source by just docs-sdk (which wraps cargo doc --no-deps --package binoc-sdk) and rebuilt in CI on every docs deploy, so it tracks main. For a published-version view, see binoc-sdk on docs.rs; for a local checkout, cargo doc --no-deps --package binoc-sdk --open opens the same content in your browser.

The published Rust surface

binoc-sdk is the only Rust crate published to crates.io. It contains everything a third-party Rust plugin needs:

  • Correspondence rule traits: expand, parse, pair, edit-list writer, compaction, projection annotator, and engine config types.
  • Stable plugin traits: currently renderers.
  • IR types: DiffNode, Changeset, ItemRef, ItemPair, edit lists, link proposals, diagnostics, summaries, and detail blocks.
  • Data access: the DataAccess trait.
  • Descriptors: rule descriptors and renderer descriptors.
  • Artifact types: ArtifactFormat, ArtifactSubject, ArtifactDescriptor, tabular_v1, and helpers for publishing / consuming artifacts.
  • ABI helpers for stable-tier plugin surfaces.

Internal crates (binoc-core, binoc-stdlib, binoc-cli, binoc-python) are not published and do not have hosted reference docs. This is deliberate ā€” see Release surface and automated publishing ADR and Plugin SDK and ABI ADR.

Depending on it

[dependencies]
binoc-sdk = "0.1"

or

cargo add binoc-sdk

For a worked end-to-end example, see Write a Rust rule pack, Plugin model, and the reference implementations under model-plugins/binoc-sqlite.