Schema del socket Wasm del parser di Aggrega
Riferimento generato. Non modificarlo a mano — rigeneralo a partire dal JSON Schema pubblicato.
Id dello schema: https://aggrega.ai/schemas/wasm-parse-v1beta1.schema.json
Le forme di trasmissione che un socket di plugin parser consuma (ParseInput) ed emette (ParseOutput). Un parser è un trasformatore senza stato e privo di effetti collaterali che trasforma una rappresentazione testuale esterna in un albero JSON strutturato canonico, così qualsiasi consumatore in qualsiasi linguaggio può leggere l’albero senza dover includere un proprio parser del linguaggio. Un parser dichiara i formati che gestisce come capacità parse:
Una delle forme seguenti
ParseInputParseOutput
Definizioni
ParseInput
Il payload che un guest parser riceve: il nome del formato che seleziona come leggere i byte, i byte del sorgente da analizzare e un documento di opzioni opaco facoltativo che il consumatore fornisce per un comportamento specifico del parser.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
format | string | sì | Il nome del formato sorgente da analizzare, corrispondente a una delle capacità parse: |
bytes | string | sì | I byte del sorgente da analizzare. Ogni kit li porta nel proprio tipo di campo — grezzi dove quel tipo è un tipo di byte, codificati in base64 dove è una stringa che il parser decodifica per recuperarli — e l’encoder generato converte tra il campo e la forma in cui il formato di trasmissione porta i byte. Il parser legge i byte recuperati nel formato nominato. |
options | any | no | Un documento di opzioni opaco che il consumatore fornisce per un comportamento specifico del parser. L’host lo fa passare senza interpretarlo; il parser legge qualunque forma esso documenti. Assente quando il consumatore non fornisce opzioni. |
Non sono consentite proprietà aggiuntive.
ParseOutput
Il payload che un guest parser restituisce: l’albero strutturato canonico del sorgente analizzato, più eventuali diagnostiche sollevate dall’analisi ed eventuali intervalli del sorgente che riconducono i nodi dell’albero ai byte originali.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
tree | any | sì | La vista strutturata canonica del sorgente analizzato, come documento JSON. Qui «documento JSON» nomina la forma del valore che un parser produce — che è la sostanza di ciò a cui serve l’analisi — e non la codifica in cui il valore viaggia: l’albero è un documento JSON qualunque sia il formato di trasmissione con cui questo socket lo porta. Il livello superiore può essere un oggetto, un array o uno scalare, corrispondente alla forma propria del documento analizzato (un file JSON, per esempio, può essere analizzato in uno qualsiasi di questi). L’host fa passare l’albero in modo opaco, portandolo alla lettera senza interpretarne il contenuto. |
diagnostics | Diagnostic[] | no | Diagnostiche sollevate dall’analisi — per esempio un errore di sintassi o un avviso. Assente quando l’analisi non ne ha prodotta nessuna. |
spans | NodeSpan[] | no | Intervalli del sorgente che riconducono i nodi dell’albero alla loro posizione nei byte originali, così un consumatore può far corrispondere un rilievo su un nodo dell’albero a una posizione nel sorgente. Assente quando il parser non riporta alcun intervallo. |
error | string | no | Un messaggio di errore impostato quando il guest è stato eseguito ma non ha potuto completare l’operazione; assente in caso di successo. È distinto da qualsiasi diagnostica portata dall’output: le diagnostiche riportano problemi trovati durante un’esecuzione che ha comunque prodotto un risultato, mentre error riporta che l’operazione stessa non è stata completata. L’host presenta un errore presente come un’invocazione del plugin non riuscita. |
Non sono consentite proprietà aggiuntive.
NodeSpan
Un intervallo del sorgente per un nodo dell’albero: un JSON Pointer RFC 6901 che indirizza il nodo all’interno dell’albero, abbinato all’intervallo che lo localizza nei byte originali.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
pointer | string | sì | Un JSON Pointer RFC 6901 nell’albero, che indirizza il nodo che questo intervallo localizza. |
span | SourceSpan | sì | L’intervallo che localizza il nodo indirizzato nei byte originali. |
Non sono consentite proprietà aggiuntive.
SourceSpan
Un intervallo dei byte del sorgente originale: gli offset in byte sono la posizione primaria ed esatta, e i numeri di riga e di colonna li accompagnano per diagnostiche leggibili da una persona.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
start_offset | integer | sì | L’offset in byte del primo byte dell’intervallo nel sorgente originale, a partire da zero. |
end_offset | integer | sì | L’offset in byte successivo all’ultimo byte dell’intervallo nel sorgente originale, così end_offset meno start_offset è la lunghezza dell’intervallo in byte. |
start_line | integer | sì | Il numero di riga dell’inizio dell’intervallo, a partire da uno, per diagnostiche leggibili da una persona. |
start_column | integer | sì | Il numero di colonna dell’inizio dell’intervallo, a partire da uno, per diagnostiche leggibili da una persona. |
end_line | integer | sì | Il numero di riga della fine dell’intervallo, a partire da uno, per diagnostiche leggibili da una persona. |
end_column | integer | sì | Il numero di colonna della fine dell’intervallo, a partire da uno, per diagnostiche leggibili da una persona. |
Non sono consentite proprietà aggiuntive.
ParseSourceResponse
La risposta della funzione host parse-source: in caso di successo l’albero strutturato canonico prodotto dal parser risolto, in caso di fallimento un messaggio di errore. Esattamente uno dei due campi è popolato. Il fallimento viene consegnato in banda anziché tramite trap, così un guest consumatore porta un caso di parser assente o un fallimento dell’analisi nelle proprie diagnostiche come un fallimento deterministico. Questa è la busta che un socket consumatore riceve quando chiede all’host di eseguire un producer tramite l’host; il payload della richiesta è un ParseInput.
| Proprietà | Tipo | Obbligatoria | Descrizione |
|---|---|---|---|
tree | any | no | L’albero strutturato canonico che il parser risolto ha prodotto in caso di successo, come documento JSON portato alla lettera; assente in caso di fallimento. Come per l’albero proprio dell’output dell’analisi, «documento JSON» nomina la forma del valore anziché la codifica in cui viaggia. |
error | string | no | Il messaggio di errore in caso di fallimento, che nomina il formato e il motivo; assente in caso di successo. |
hostfunc_error_code | string (enum) | no | L’identità del fallimento riconoscibile automaticamente in caso di fallimento, tratta dal catalogo chiuso dei codici di errore delle funzioni host, impostata accanto al messaggio di errore leggibile dalle persone; assente in caso di successo. Quel catalogo è un vocabolario fisso che nomina i modi in cui una funzione host può fallire, ed è un vocabolario diverso dalle condizioni di arresto che il compilatore registra, i cui identificatori un guest riporta su un output di socket come condition_code e condition_short_code — il nome della chiave dice a quale dei due appartiene un valore, così i due non vengono mai letti come un unico insieme. Un guest si dirama su questo codice senza analizzare il messaggio, tollerando un codice assente (host più vecchio) o uno non riconosciuto (host più recente) ripiegando sul messaggio. Valori consentiti: "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" |
Non sono consentite proprietà aggiuntive.