Expand description
BRIDGE packet line codec for SIM.
This crate provides codec:bridge, a strict reversible text face for one
BRIDGE packet per frame. It owns the packet record model, the standard part
and move books, content-addressed packet identity, and the ownership checks
used by model-facing renderers. It does not run packets, invoke tools, or
choose transports.
Structs§
- Bridge
Attest Payload - Attestation payload citing evidence for a claim.
- Bridge
Book - A BRIDGE book bundles the part book and move book used for a packet.
- Bridge
Call Argument - One packed argument in a
bridge/Callpayload. - Bridge
Call Payload - Typed payload for a
bridge/Callpart. - Bridge
Codec - The
codec:bridgedecoder/encoder. - Bridge
Codec Lib - Host-registered lib that installs
BridgeCodecascodec:bridge. - Bridge
Evidence Payload - Evidence payload attached to a collaboration packet.
- Bridge
Frame Book - Registry of BRIDGE frame specifications.
- Bridge
Frame Payload - Typed payload for a
bridge/Framepart. - Bridge
Header - Fixed, fast-scan BRIDGE packet header.
- Bridge
Move Book - Registry of legal BRIDGE moves.
- Bridge
Move Spec - Registered dialogue move specification.
- Bridge
Packet - One BRIDGE packet, carrying a header, ordered typed parts, and optional warrant.
- Bridge
Part - One typed body part in a BRIDGE packet.
- Bridge
Part Book - Registry of BRIDGE part-kind specifications.
- Bridge
Part Spec - Registered BRIDGE part-kind specification.
- Bridge
Patch Payload - Patch payload targeting an exact parent packet and path.
- Bridge
Profile Book - Registry of BRIDGE profile specifications.
- Bridge
Profile Spec - Registered BRIDGE profile.
- Bridge
Provenance - Provenance carried in the BRIDGE header.
- Bridge
Receipt Payload - Receipt payload for an accepted or rejected collaboration step.
- Bridge
Review Payload - Review payload targeting one packet path.
- Bridge
Score - One axis in a structured collaboration vote.
- Bridge
Vote Payload - Vote payload with one or more structured score axes.
- Bridge
Warrant - Content ids of protocol books and part specs used to build a packet.
- Bridge
Weave Payload - Typed payload for a
bridge/Weavepart. - Bridge
Weave Row - One operation-led LOOM row.
- Frame
Hole Spec - One named typed hole in a frame template.
- Frame
Spec - Registered frame specification.
- Profile
Part Rule - One part-kind rule in a BRIDGE profile.
Enums§
- Authority
Class - Authority class for a registered BRIDGE part kind.
- Bridge
Warrant Policy - Policy for checking packet warrants at receive time.
- Call
Argument Media - Media kind carried by a packed ASK call argument.
- Frame
Hole Kind - Hole kind for a typed BRIDGE frame slot.
- Frame
Kind - Illocutionary kind for a BRIDGE frame.
- Owned
Span - A rendered byte span owned by one BRIDGE packet component.
- Profile
Part Count - Repetition rule for a profile part kind.
- Render
Class - Rendering class for a registered BRIDGE part kind.
- Reply
Rule - Parent-intent rule for a BRIDGE move.
- Unknown
Policy - Policy for preserving a part kind that is not in the standard normative book.
Statics§
- RECIPES
- Cookbook recipes for this codec, embedded at build time.
Functions§
- ask_
profile_ spec - Builds the ASK profile spec:
Given* Frame* Call+ Return. - ask_
profile_ symbol - Profile id for ASK packets.
- assert_
roundtrip - Asserts that encoding then decoding reproduces the same packet.
- assert_
total_ ownership - Asserts that spans exactly cover the full rendered face in order.
- bridge_
packet_ shape_ symbol - Returns the packet shape symbol owned by the BRIDGE codec.
- bridge_
profile_ shape_ expr - Shape descriptor for the registered BRIDGE profile catalog.
- brief_
profile_ spec - Builds the BRIEF profile spec:
Given* Frame+ Return?. - brief_
profile_ symbol - Profile id for BRIEF packets.
- canonical_
packet_ datum - Builds the canonical datum used to hash a packet with
cidcleared. - collab_
profile_ spec - Builds the COLLAB profile spec:
(Review|Vote|Patch|Evidence|Receipt|Attest)+. - collab_
profile_ symbol - Profile id for COLLAB packets.
- content_
id_ string - Returns the stable text form of a content id.
- decode_
bridge_ text - Decodes the strict
BRIDGE/1line face to a BRIDGE packet. - derive_
weave_ result_ shape - Derives the public result Shape descriptor for a sequence of weave rows.
- encode_
bridge_ text - Encodes a BRIDGE packet to the strict
BRIDGE/1line face. - expr_
to_ packet - Validate a canonical packet expression back into a typed packet.
- frame_
book_ content_ id - Computes the content id for a fluent frame book registry record.
- loom_
profile_ spec - Builds the LOOM profile spec:
Given* Frame* Weave+ Return. - loom_
profile_ symbol - Profile id for LOOM packets.
- move_
book_ content_ id - Computes the content id for a dialogue move book registry record.
- packet_
content_ id - Computes the canonical content id for a packet with
cidcleared. - packet_
to_ expr - Project a packet to the canonical expression record used by
codec:bridge. - part_
spec_ content_ id - Computes the content id for one part-kind registry record.
- render_
frame - Renders a frame payload through its deterministic sentence template.
- render_
frame_ part - Renders a
bridge/Framepart as a cited fluent sentence. - render_
frame_ part_ with_ prose - Renders a
bridge/Framepart as a cited fluent sentence, delegating prose holes torender_prose. - render_
frame_ with_ prose - Renders a frame payload, delegating prose holes to
render_prose. - stamp_
packet_ cid - Returns a packet with its canonical cid stamped into the header.
- standard_
frame_ book - Builds the standard BRIDGE frame book.
- standard_
move_ book - Builds the standard BRIDGE move book.
- standard_
part_ book - Builds the standard BRIDGE part book.
- standard_
profile_ book - Builds the standard BRIDGE profile book.
- validate_
call_ payload - Parses and validates a
bridge/Callpayload. - validate_
collab_ payload - Validates a collaboration part payload for its registered part kind.
- validate_
weave_ payload - Parses and validates a
bridge/Weavepayload. - verify_
packet_ cid - Verifies that a packet’s stamped cid matches its canonical content.
- warrant_
for_ packet - Builds the warrant for
packetfrom the local bridge book.
Type Aliases§
- Weave
Part - Roadmap-facing alias for a typed weave part payload.