API reference — main (unreleased)
This generated reference records API present in the source used for this build. It makes no claim about artifact available, build checked, runtime tested, integration tested, or maintainer-supported for any listed item. Consult the claims and evidence guide for evidence beyond API presence.
Rust core
Section titled “Rust core”Open the generated safemesh-crdt reference.
The documentation build requires Linux. Cargo runs rustdoc during npm --prefix docs run build, using all features on Linux, including local-writer and laws.
This is a view of main (unreleased), not a version-matched release manual or a portability claim.
Use these entries to move from the guided examples to the API they exercise:
| Task | Rust reference entry | Requirement |
|---|---|---|
| Apply and read G-Counter or OR-Set carrier operations | GCounter, OrSet | No additional feature |
| Admit records and select missing records for repair | EventLog::admit_with, EventLog::since | No additional feature |
| Encode and decode records for transport | WireEncode::to_wire_bytes, WireDecode::from_wire_bytes | No additional feature |
| Restart the Rust gold path’s durable counter or UTF-8 set | DurableReplica::restart_counter, DurableReplica::restart_utf8_set | Linux, local-writer |
| Test a custom type’s merge laws and delta convergence | check_merge_laws, check_crdt_convergence | laws; admission also needs behavioral tests of Crdt::validate_record |
Site search covers all guides and the generated Rust reference, including source pages; it does not index the contents of linked GitHub documents. Rustdoc provides a separate item search for Rust items. Rustdoc also provides navigation and source links. The “SafeMesh reference guide” link returns here. External Rust documentation references are displayed as text with their original URL in a tooltip, so browsing and checking this reference does not require a third-party documentation host. Rustdoc’s “Stable since Rust version” tooltips refer to standard-library API versions; they do not establish SafeMesh support.
State wire entry lists must be strictly ascending and duplicate-free in encoder order (map keys, set elements or full pairs, including tombstones), with violations refused as NonCanonicalOrder or DuplicateEntry (NonCanonicalVersionVector for version-vector duplicates); OR-Set Remove token lists (numeric and UTF-8) are sorted and deduplicated by the encoder; Enable-wins Flag Disable token lists are also sorted and deduplicated by the encoder, while decoders still read older unsorted lists.