API Reference

The pattern-rs library is published in three languages. Each has its own generated API reference built from the source at build time.

Rust

Crates relateby-pattern and relateby-gram, generated by cargo doc.

Covers: Pattern<V>, Subject, Symbol, StandardGraph, Combinable, parse_gram, to_gram, and all codec types.

• Rust API Reference

Python

Subpackages relateby.pattern and relateby.gram, generated by pdoc.

Covers: Pattern, Subject, Value, StandardGraph, gram.parse, gram.stringify.

• Python API Reference

TypeScript

Packages @relateby/pattern, @relateby/gram, and @relateby/graph, generated by TypeDoc.

Covers: Pattern<V>, Subject, StandardGraph, Gram.parse, Gram.stringify, graph interfaces, and all Effect-based operations.

• TypeScript API Reference

Note: API reference sub-sites are generated at build time from the source.
Run ./docs/scripts/build.sh locally to generate them.