Aggrega-Schema für den Wasm-Parser-Socket
Generierte Referenz. Nicht von Hand bearbeiten — aus dem veröffentlichten JSON Schema neu generieren.
Schema-ID: https://aggrega.ai/schemas/wasm-parse-v1beta1.schema.json
Die Übertragungsformen, die ein Parser-Plugin-Socket konsumiert (ParseInput) und ausgibt (ParseOutput). Ein Parser ist ein zustandsloser, nebeneffektfreier Transformator, der eine fremde Textdarstellung in einen kanonischen strukturierten JSON-Baum überführt, sodass jeder Konsument in jeder Sprache den Baum lesen kann, ohne einen eigenen Sprachparser mitzuführen. Ein Parser deklariert die Formate, die er verarbeitet, als parse:
Eine der folgenden Formen
ParseInputParseOutput
Definitionen
ParseInput
Die Payload, die ein Parser-Guest erhält: den Formatnamen, der auswählt, wie die Bytes zu lesen sind, die zu parsenden Quellbytes und ein optionales opakes Optionsdokument, das der Konsument für parserspezifisches Verhalten liefert.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
format | string | ja | Der Name des zu parsenden Quellformats, passend zu einer der angekündigten parse: |
bytes | string | ja | Die zu parsenden Quellbytes. Jedes Kit trägt sie in seinem eigenen Feldtyp — roh, wo dieser Typ ein Bytetyp ist, base64-kodiert, wo er eine Zeichenkette ist, die der Parser dekodiert, um sie zurückzugewinnen —, und der generierte Encoder konvertiert zwischen dem Feld und der Form, in der das Übertragungsformat Bytes trägt. Der Parser liest die zurückgewonnenen Bytes als das genannte Format. |
options | any | nein | Ein opakes Optionsdokument, das der Konsument für parserspezifisches Verhalten liefert. Der Host reicht es durch, ohne es zu interpretieren; der Parser liest jede Form, die er dokumentiert. Fehlt, wenn der Konsument keine Optionen liefert. |
Zusätzliche Eigenschaften sind nicht zulässig.
ParseOutput
Die Payload, die ein Parser-Guest zurückgibt: den kanonischen strukturierten Baum der geparsten Quelle sowie alle Diagnosen, die das Parsen ausgelöst hat, und alle Quellbereiche, die Baumknoten auf die ursprünglichen Bytes zurückführen.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
tree | any | ja | Die kanonische strukturierte Sicht der geparsten Quelle als JSON-Dokument. Hier benennt „JSON-Dokument“ die Form des Werts, den ein Parser erzeugt — was den Kern dessen ausmacht, wofür Parsen da ist —, und nicht die Kodierung, in der der Wert übertragen wird: Der Baum ist ein JSON-Dokument, unabhängig davon, in welchem Übertragungsformat dieser Socket ihn trägt. Die oberste Ebene kann ein Objekt, ein Array oder ein Skalar sein, passend zur eigenen Form des geparsten Dokuments (eine JSON-Datei kann zum Beispiel zu jedem davon geparst werden). Der Host reicht den Baum opak durch und trägt ihn wörtlich, ohne seinen Inhalt zu interpretieren. |
diagnostics | Diagnostic[] | nein | Diagnosen, die das Parsen ausgelöst hat — zum Beispiel ein Syntaxfehler oder eine Warnung. Fehlt, wenn das Parsen keine erzeugt hat. |
spans | NodeSpan[] | nein | Quellbereiche, die Baumknoten auf ihre Position in den ursprünglichen Bytes zurückführen, sodass ein Konsument einen Befund an einem Baumknoten einem Ort in der Quelle zuordnen kann. Fehlt, wenn der Parser keine Bereiche meldet. |
error | string | nein | Eine Fehlermeldung, die gesetzt wird, wenn der Guest lief, die Operation aber nicht abschließen konnte; fehlt bei Erfolg. Sie ist von allen Diagnosen getrennt, die die Ausgabe trägt: Diagnosen melden Probleme, die während eines Laufs gefunden wurden, der dennoch ein Ergebnis erzeugt hat, während error meldet, dass die Operation selbst nicht abgeschlossen wurde. Der Host meldet einen vorhandenen Fehler als fehlgeschlagenen Plugin-Aufruf. |
Zusätzliche Eigenschaften sind nicht zulässig.
NodeSpan
Ein Quellbereich für einen Baumknoten: ein JSON Pointer nach RFC 6901, der den Knoten innerhalb des Baums adressiert, gepaart mit dem Bereich, der ihn in den ursprünglichen Bytes lokalisiert.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
pointer | string | ja | Ein JSON Pointer nach RFC 6901 in den Baum, der den Knoten adressiert, den dieser Bereich lokalisiert. |
span | SourceSpan | ja | Der Bereich, der den adressierten Knoten in den ursprünglichen Bytes lokalisiert. |
Zusätzliche Eigenschaften sind nicht zulässig.
SourceSpan
Ein Bereich der ursprünglichen Quellbytes: Die Byte-Offsets sind der primäre, exakte Ort, und die Zeilen- und Spaltennummern begleiten sie für menschenlesbare Diagnosen.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
start_offset | integer | ja | Der Byte-Offset des ersten Bytes des Bereichs in der ursprünglichen Quelle, nullbasiert. |
end_offset | integer | ja | Der Byte-Offset eins hinter dem letzten Byte des Bereichs in der ursprünglichen Quelle, sodass end_offset minus start_offset die Länge des Bereichs in Bytes ist. |
start_line | integer | ja | Die Zeilennummer des Anfangs des Bereichs, einsbasiert, für menschenlesbare Diagnosen. |
start_column | integer | ja | Die Spaltennummer des Anfangs des Bereichs, einsbasiert, für menschenlesbare Diagnosen. |
end_line | integer | ja | Die Zeilennummer des Endes des Bereichs, einsbasiert, für menschenlesbare Diagnosen. |
end_column | integer | ja | Die Spaltennummer des Endes des Bereichs, einsbasiert, für menschenlesbare Diagnosen. |
Zusätzliche Eigenschaften sind nicht zulässig.
ParseSourceResponse
Die Antwort der Host-Funktion parse-source: bei Erfolg der kanonische strukturierte Baum, den der aufgelöste Parser erzeugt hat, bei einem Fehlschlag eine Fehlermeldung. Genau eines der beiden Felder ist befüllt. Ein Fehlschlag wird in-band statt durch einen Trap übermittelt, sodass ein konsumierender Guest einen fehlenden Parser oder einen Parse-Fehlschlag als deterministischen Fehlschlag in seine eigenen Diagnosen übernimmt. Dies ist der Umschlag, den ein konsumierender Socket erhält, wenn er den Host bittet, einen Producer über den Host auszuführen; die Payload der Anfrage ist ein ParseInput.
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
tree | any | nein | Der kanonische strukturierte Baum, den der aufgelöste Parser bei Erfolg erzeugt hat, als wörtlich getragenes JSON-Dokument; fehlt bei einem Fehlschlag. Wie beim eigenen Baum der Parse-Ausgabe benennt „JSON-Dokument“ die Form des Werts und nicht die Kodierung, in der er übertragen wird. |
error | string | nein | Die Fehlermeldung bei einem Fehlschlag, die das Format und den Grund nennt; fehlt bei Erfolg. |
hostfunc_error_code | string (enum) | nein | Die maschinell abgleichbare Identität des Fehlschlags bei einem Fehlschlag, aus dem geschlossenen Katalog der Fehlercodes für Host-Funktionen, neben der für Menschen lesbaren Fehlermeldung gesetzt; fehlt bei Erfolg. Dieser Katalog ist ein festes Vokabular, das die Arten benennt, auf die eine Host-Funktion fehlschlagen kann, und er ist ein anderes Vokabular als die Abbruchbedingungen, die der Compiler registriert und deren Bezeichner ein Guest auf einer Socket-Ausgabe als condition_code und condition_short_code meldet — der Schlüsselname sagt, zu welchem der beiden ein Wert gehört, sodass die beiden nie als eine Menge gelesen werden. Ein Guest verzweigt nach diesem Code, ohne die Meldung zu parsen, und toleriert einen fehlenden Code (älterer Host) oder einen nicht erkannten (neuerer Host), indem er auf die Meldung zurückfällt. Zulässige Werte: "fetch_request_unreadable", "fetch_input_unavailable", "fetch_failed", "request_unreadable", "request_undecodable", "source_root_unavailable", "source_read_failed", "unknown_selection_op", "source_escape", "producer_consumption_reentry", "no_source_parser", "no_parser_for_format", "parse_failed" |
Zusätzliche Eigenschaften sind nicht zulässig.