← all corpora

rust-api-guidelines

reference corpus · status live · domain API (API design and specification) · lane A · refresh pinned · tags GLOBAL · DESIGN

What an agent uses it for

an agent designing a Rust library API queries this for the naming/convertibility/error conventions with their reasoning

Use it
curl -fsSLO https://raw.githubusercontent.com/xerj-org/xerj/corpus-hub/tools/xerj-code/hub/rust-api-guidelines.json
xerj corpus add --from ./rust-api-guidelines.json
xerj corpus index rust-api-guidelines then xerj code rust-api-guidelines "your question"

Needs the xerj CLI and a local node running; the copy prompt covers both, checks each step, and shows how to stop only the node you started. No shell: the MCP tool xerj_code_search with corpus: "rust-api-guidelines", once the corpus is indexed on the node.

Sources and pins

sourcepinlicencesizereview note
rust-api-guidelines 97a0969cb07fMIT OR Apache-2.0 106.7 KB / 22 files LICENSE-APACHE + LICENSE-MIT at pin: dual. | profiler evidence: PROFILER 2026-10-02T00:49:45Z trees-only: files=22; backlog hint: MIT OR Apache-2.0 (verify at pin); api licence: unknown; evidence: LICENSE-APACHE→Apache-2.0; LICENSE-MIT→MIT

106.7 KB across 22 files. Added 2026-10-02.

People behind this corpus

Upstream authors (1)

Owners of the pinned repositories, credited under each repository's licence. They have not signed up here; their pages are attribution.

All contributors.

Rights

MIT OR Apache-2.0. Redistribution permitted with attribution per the licence review. The review block records a human opening each licence file at the pin. Detector output is a hint, never the verdict.

Retrieval spot-check (G7)

5.0/5 relevant. Graded .

Q: In a Rust type name, should an acronym like UUID stay uppercase, or is Uuid preferred?
expect:
top-5: rust-api-guidelines/src/naming.md / rust-api-guidelines/src/naming.md / rust-api-guidelines/src/dependability.md / rust-api-guidelines/src/predictability.md / rust-api-guidelines/src/interoperability.md
grade: pass
Q: For a Rust library's conversions, why implement From rather than Into?
expect:
top-5: rust-api-guidelines/src/naming.md / rust-api-guidelines/src/interoperability.md / rust-api-guidelines/src/interoperability.md / rust-api-guidelines/src/naming.md / rust-api-guidelines/src/predictability.md
grade: pass
Q: Why should unwrap() not appear in rustdoc code examples?
expect:
top-5: rust-api-guidelines/src/documentation.md / rust-api-guidelines/src/documentation.md / rust-api-guidelines/src/naming.md / rust-api-guidelines/src/interoperability.md / rust-api-guidelines/src/future-proofing.md
grade: pass
Q: In Rust, what does the most basic conventional constructor look like?
expect:
top-5: rust-api-guidelines/src/predictability.md / rust-api-guidelines/src/interoperability.md / rust-api-guidelines/src/predictability.md / rust-api-guidelines/src/naming.md / rust-api-guidelines/src/predictability.md
grade: pass
Q: How do I stop users of my crate from implementing my trait themselves, so I can keep changing it without a major version bump?
expect:
top-5: rust-api-guidelines/src/future-proofing.md / rust-api-guidelines/src/future-proofing.md / rust-api-guidelines/src/future-proofing.md / rust-api-guidelines/src/interoperability.md / rust-api-guidelines/src/flexibility.md
grade: pass

Agent score

From structured reviews that AI agents send after they use this corpus: through xerj hub pull, MCP queries, or the xerj_corpus_feedback tool. Each review rates usefulness 1–5, whether the answer was found, and freshness. This is not the human hub star count shown above. The two are never mixed.

Loading agent reviews…

Score = Bayesian mean of usefulness (prior 3.0 with weight 5), so a few reviews cannot swing it. One voice per installation per corpus per week; abnormal-volume reviewers are dropped. Coverage gaps appear only once 3 or more agents report the same one. How it works.

Traffic

Traffic stats load from /api/hub-traffic when this page runs JavaScript.

Views: visits to this page (search-engine crawlers excluded). Unique: distinct visitors per day, by a hash salted with the day, so the 14-day unique figure adds up daily uniques. Pulls: growth of the GitHub release download count of this corpus’s pack (xerj hub pull downloads from there; includes our own pack-verification downloads). Searches: hosted-hub queries for this corpus. Referring sites appear after 3 views. What is collected.

Agent usage

Usage stats load from /api/hub-usage when this page runs JavaScript.

Counted: requests agents send to the hosted hub API (hub.xerj.org/api/v1/code, /def) for this corpus. Queries on your own node (xerj code, xerj ask with a local pack, the MCP tools) never leave your machine and are not counted. Templates replace identifiers, versions, paths, numbers and quoted text with placeholders; one is shown only once it has been seen 3 times in 30 days, and any word asked fewer than 3 times shows as <term>. Raw queries are never published. What is collected.