panproto-protocols 0.18.1

Built-in protocol definitions for panproto
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

# panproto-protocols

[![crates.io](https://img.shields.io/crates/v/panproto-protocols.svg)](https://crates.io/crates/panproto-protocols)
[![docs.rs](https://docs.rs/panproto-protocols/badge.svg)](https://docs.rs/panproto-protocols)

Built-in protocol definitions for panproto.

Each of the 50 protocols is defined by a schema theory [GAT](https://ncatlab.org/nlab/show/generalized+algebraic+theory) and an instance theory GAT, composed via [colimit](https://ncatlab.org/nlab/show/colimit) from 27 reusable building-block theories organized in six groups. This crate includes parsers for each protocol's native schema format.

Programming language and data format parsing (previously handled by hand-written protocol parsers for SQL, Protobuf, GraphQL, and others) is now handled by tree-sitter grammars in `panproto-parse`. The protocols that remain here are semantic protocols: annotation formats, domain-specific schemas, and formats that have no tree-sitter grammar.

## Protocols

| Protocol | Schema type | Instance type | Parser |
|----------|-------------|---------------|--------|
| [ATProto](https://atproto.com/) | Constrained multigraph | W-type | Lexicon JSON |
| [OpenAPI](https://www.openapis.org/) | Constrained multigraph | W-type | YAML/JSON |
| [WASI](https://wasi.dev/) | Simple graph | Flat | WIT |
| [Cap'n Proto](https://capnproto.org/) | Simple graph | Flat | `.capnp` files |
| ...and 46 more | | | |

See the [protocol catalog](https://panproto.dev/tutorial/appendices/D-protocol-catalog.html) for the full list.

## Building-Block Theories (27)

Protocols compose their schema and instance theories from reusable building blocks via colimit:

| Group | Theories |
|-------|----------|
| A: Core graphs | ThGraph, ThSimpleGraph, ThHypergraph, ThConstraint, ThMulti, ThInterface |
| B: Instance shapes | ThWType, ThMeta, ThFunctor, ThFlat |
| C: Structure | ThOrder, ThCoproduct, ThRecursion, ThSpan, ThCospan, ThPartial, ThLinear, ThNominal |
| D: Symmetry | ThReflexiveGraph, ThSymmetricGraph |
| E: Process | ThPetriNet, ThCausal |
| F: Composition | ThGraphInstance, ThAnnotation, ThOperad, ThTracedMonoidal, ThSimplicial |

## API

| Item | Description |
|------|-------------|
| `atproto` / `openapi` / `wasi` / `capnp` / ... | Protocol modules with definitions, parsers, and theory registration |
| `theories` | All 27 building-block theory definitions |
| `ProtocolError` | Error type |

## Example

```rust,ignore
use panproto_protocols::atproto;

let protocol = atproto::protocol();
let schema = atproto::parse_lexicon(&lexicon_json)?;
```

## License

[MIT](../../LICENSE)