Crate sim_codec_bridge

Expand description

BRIDGE packet line codec for SIM.

This crate provides codec:bridge, the strict reversible text face for one BRIDGE packet per frame. BRIDGE is a single packet protocol for exchanges between SIM, humans, and models; this crate owns the packet record model and its codec, and nothing that runs, sends, or repairs a packet (that is sim-lib-bridge).

§The packet

BridgePacket
  header    move, from, to, role, parents, task, output, ceiling, provenance
  body      an ordered list of typed parts (a closed part book):
            Given Frame Call Weave Check Evidence Review Vote Patch
            Fetch Return Receipt Attest
  warrant   content ids of the books/specs the packet was built against

BRIEF, ASK, LOOM, and COLLAB are not separate protocols – they are BridgeProfileSpec shapes over the body (frame-led, call-led, weave-led, and review/vote/patch-led). A packet body must derive exactly one profile; there is one codec and one checker for all four (standard_profile_book).

§What this crate guarantees

Reversible identity. packet_content_id / stamp_packet_cid / verify_packet_cid give a packet a content-addressed cid, and assert_roundtrip proves the line form (encode_bridge_text / decode_bridge_text) decodes back to the identical record.
Move, profile, and part legality. BridgeBook::validate_packet checks every packet before text decode or expression encode returns canonical data. BridgeMoveBook / standard_move_book say which move may answer which explicit parent #move=<intent> evidence (a vote may not answer a request); BridgeProfileBook / standard_profile_book require BRIEF, ASK, LOOM, or COLLAB to be the single body match; and BridgePartBook / standard_part_book say which typed parts are legal and whether an unknown part is rejected or preserved as inert data (UnknownPolicy, AuthorityClass).
Total text ownership. assert_total_ownership proves every rendered byte a model sees belongs to a structural token, a frame sentence (render_frame_part), a part line, or a nonce-fenced datum – there is no free-prose channel for a hidden instruction. A Frame renders both a checked record and a fluent cited sentence.
Warrants. warrant_for_packet records the move/frame/part-spec content ids so a receiver can validate a packet against its own books across a trust or version boundary. The standard codec accepts missing warrants under shared trust; a book configured with BridgeWarrantPolicy::Verify requires and checks a matching warrant.

The runtime side – send/receive checking, capability ceilings, model requests, the frontier engine, and the profile helpers – lives in sim-lib-bridge; the human review surface lives in sim-lib-view-bridge.

Structs§

BridgeAttestPayload: Attestation payload citing evidence for a claim.
BridgeBook: A BRIDGE book bundles the part book and move book used for a packet.
BridgeCallArgument: One packed argument in a bridge/Call payload.
BridgeCallPayload: Typed payload for a bridge/Call part.
BridgeCodec: The codec:bridge decoder/encoder.
BridgeCodecLib: Host-registered lib that installs BridgeCodec as codec:bridge.
BridgeEvidencePayload: Evidence payload attached to a collaboration packet.
BridgeFrameBook: Registry of BRIDGE frame specifications.
BridgeFramePayload: Typed payload for a bridge/Frame part.
BridgeHeader: Fixed, fast-scan BRIDGE packet header.
BridgeMoveBook: Registry of legal BRIDGE moves.
BridgeMoveSpec: Registered dialogue move specification.
BridgePacket: One BRIDGE packet, carrying a header, ordered typed parts, and optional warrant.
BridgePart: One typed body part in a BRIDGE packet.
BridgePartBook: Registry of BRIDGE part-kind specifications.
BridgePartSpec: Registered BRIDGE part-kind specification.
BridgePatchPayload: Patch payload targeting an exact parent packet and path.
BridgeProfileBook: Registry of BRIDGE profile specifications.
BridgeProfileSpec: Registered BRIDGE profile.
BridgeProvenance: Provenance carried in the BRIDGE header.
BridgeReceiptPayload: Receipt payload for an accepted or rejected collaboration step.
BridgeReviewPayload: Review payload targeting one packet path.
BridgeScore: One axis in a structured collaboration vote.
BridgeVotePayload: Vote payload with one or more structured score axes.
BridgeWarrant: Content ids of protocol books and part specs that build a packet.
BridgeWeavePayload: Typed payload for a bridge/Weave part.
BridgeWeaveRow: One operation-led LOOM row.
FrameHoleSpec: One named typed hole in a frame template.
FrameSpec: Registered frame specification.
ProfilePartRule: One part-kind rule in a BRIDGE profile.

Enums§

AuthorityClass: Authority class for a registered BRIDGE part kind.
BridgeWarrantPolicy: Policy for checking packet warrants at receive time.
CallArgumentMedia: Media kind carried by a packed ASK call argument.
FrameHoleKind: Hole kind for a typed BRIDGE frame slot.
FrameKind: Illocutionary kind for a BRIDGE frame.
OwnedSpan: A rendered byte span owned by one BRIDGE packet component.
ProfilePartCount: Repetition rule for a profile part kind.
RenderClass: Rendering class for a registered BRIDGE part kind.
ReplyRule: Parent-intent rule for a BRIDGE move.
UnknownPolicy: 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 for hashing a packet with cid cleared.
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/1 line face to a BRIDGE packet.
decode_bridge_text_with_limits: Decodes the strict BRIDGE/1 line face under caller-supplied decode limits.
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/1 line 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 cid cleared.
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/Frame part as a cited fluent sentence.
render_frame_part_with_prose: Renders a bridge/Frame part as a cited fluent sentence, delegating prose holes to render_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/Call payload.
validate_collab_payload: Validates a collaboration part payload for its registered part kind.
validate_weave_payload: Parses and validates a bridge/Weave payload.
verify_packet_cid: Verifies that a packet’s stamped cid matches its canonical content.
warrant_for_packet: Builds the warrant for packet from the local bridge book.

Type Aliases§

WeavePart: Roadmap-facing alias for a typed weave part payload.