Expand description
§panproto-protocols
Built-in protocol definitions for panproto.
Each protocol is defined by a schema theory GAT and an instance theory GAT,
composed via colimit from reusable building-block theories. Every protocol
provides both a parser (native format → Schema) and an emitter
(Schema → native format) for bidirectional format conversion.
§Protocol Categories
- Serialization: Avro,
FlatBuffers, ASN.1, Bond,MsgPack - Data Schema: CDDL, BSON
- API:
OpenAPI,AsyncAPI, RAML, JSON:API - Database:
MongoDB, Cassandra,DynamoDB, Neo4j, Redis - Web/Document:
ATProto, DOCX, ODF - Data Science: Parquet, Arrow,
DataFrame - Domain:
GeoJSON, FHIR, RSS/Atom, vCard/iCal, EDI X12, SWIFT MT - Config: K8s CRD, Docker Compose,
CloudFormation, Ansible
Re-exports§
pub use error::ProtocolError;pub use web_document::atproto;
Modules§
- annotation
- Linguistic annotation format protocol definitions. Linguistic annotation format protocol definitions.
- api
- API specification protocol definitions. API specification protocol definitions.
- config
- Configuration format protocol definitions. Configuration format protocol definitions.
- data_
schema - Data schema protocol definitions. Data schema protocol definitions.
- data_
science - Data science and analytics protocol definitions. Data science and analytics protocol definitions.
- database
- Database schema protocol definitions. Database schema protocol definitions.
- domain
- Domain-specific protocol definitions. Domain-specific protocol definitions.
- emit
- Shared emit helpers for protocol serialization. Shared emit helpers for protocol serialization.
- error
- Error types for protocol operations. Error types for protocol operations.
- raw_
file - Raw file protocol for non-code files (README, LICENSE, images, etc.). Raw file protocol for non-code files.
- registry
- The canonical record of what each protocol supports. The one place a protocol’s capabilities are written down.
- serialization
- Serialization and IDL protocol definitions. Serialization and IDL protocol definitions.
- theories
- Shared component theory definitions (building-block GATs). Shared component theory definitions (11 building blocks).
- web_
document - Web and document format protocol definitions. Web and document format protocol definitions.
Functions§
- bundle_
parser_ protocols - The protocol names
parse_schema_bundleaccepts. - bundle_
project_ protocols - Protocols whose bundle parse retains per-file provenance for the VCS
(via
parse_schema_bundle_project). - document_
parser_ protocols - The protocol names
parse_schema_documentaccepts (canonical, hyphenated form). - parse_
schema_ bundle - Parse a bundle of schema documents into one
Schema, resolving cross-document references across the whole bundle. - parse_
schema_ bundle_ project - Parse a set of schema documents into per-file schemas, keyed by path.
- parse_
schema_ bundle_ within - Parse a bundle within a caller-supplied budget.
- parse_
schema_ document - Parse a single JSON schema document into a
Schema, dispatching on protocol name. - parse_
schema_ document_ within - Parse a schema document within a caller-supplied budget.
- parse_
schema_ source - Parse a text/source schema (an IDL or DDL string) into a
Schema, dispatching on protocol name. - parse_
schema_ source_ within - Parse schema source text within a caller-supplied budget.
- source_
parser_ protocols - The protocol names
parse_schema_sourceaccepts (canonical, hyphenated form).