Esquema do socket Wasm de analisador do Aggrega
Referência gerada. Não editar à mão — gerar novamente a partir do JSON Schema publicado.
ID do esquema: https://aggrega.ai/schemas/wasm-parse-v1beta1.schema.json
As formas de transmissão que um socket de plugin de analisador consome (ParseInput) e emite (ParseOutput). Um analisador é um transformador sem estado e sem efeitos secundários que transforma uma representação textual externa numa árvore JSON estruturada canónica, pelo que qualquer consumidor em qualquer linguagem pode ler a árvore sem ter de incluir o seu próprio analisador da linguagem. Um analisador declara os formatos que trata como capacidades parse:
Uma das seguintes formas
ParseInputParseOutput
Definições
ParseInput
O payload que um guest analisador recebe: o nome do formato que seleciona como ler os bytes, os bytes da fonte a analisar e um documento de opções opaco opcional que o consumidor fornece para um comportamento específico do analisador.
| Propriedade | Tipo | Obrigatória | Descrição |
|---|---|---|---|
format | string | sim | O nome do formato de origem a analisar, correspondente a uma das capacidades parse: |
bytes | string | sim | Os bytes da fonte a analisar. Cada kit transporta-os no seu próprio tipo de campo — em bruto onde esse tipo é um tipo de bytes, codificados em base64 onde é uma string que o analisador descodifica para os recuperar — e o codificador gerado converte entre o campo e a forma em que o formato de transmissão transporta bytes. O analisador lê os bytes recuperados no formato indicado. |
options | any | não | Um documento de opções opaco que o consumidor fornece para um comportamento específico do analisador. O host passa-o sem o interpretar; o analisador lê qualquer forma que ele documente. Ausente quando o consumidor não fornece opções. |
Não são permitidas propriedades adicionais.
ParseOutput
O payload que um guest analisador devolve: a árvore estruturada canónica da fonte analisada, mais quaisquer diagnósticos que a análise tenha levantado e quaisquer intervalos da fonte que relacionam os nós da árvore com os bytes originais.
| Propriedade | Tipo | Obrigatória | Descrição |
|---|---|---|---|
tree | any | sim | A vista estruturada canónica da fonte analisada, como documento JSON. Aqui, «documento JSON» designa a forma do valor que um analisador produz — que é a substância daquilo para que serve a análise — e não a codificação em que o valor viaja: a árvore é um documento JSON qualquer que seja o formato de transmissão em que este socket a transporta. O nível superior pode ser um objeto, um array ou um escalar, consoante a forma própria do documento analisado (um ficheiro JSON, por exemplo, pode ser analisado como qualquer um destes). O host passa a árvore de forma opaca, transportando-a literalmente sem interpretar o seu conteúdo. |
diagnostics | Diagnostic[] | não | Diagnósticos que a análise levantou — por exemplo, um erro de sintaxe ou um aviso. Ausente quando a análise não produziu nenhum. |
spans | NodeSpan[] | não | Intervalos da fonte que relacionam os nós da árvore com a sua posição nos bytes originais, pelo que um consumidor pode associar uma constatação num nó da árvore a uma localização na fonte. Ausente quando o analisador não reporta nenhum intervalo. |
error | string | não | Uma mensagem de falha definida quando o guest foi executado, mas não conseguiu concluir a operação; ausente em caso de sucesso. É distinta de quaisquer diagnósticos que a saída transporte: os diagnósticos reportam problemas encontrados durante uma execução que ainda assim produziu um resultado, enquanto error reporta que a própria operação não foi concluída. O host apresenta um erro presente como uma invocação de plugin falhada. |
Não são permitidas propriedades adicionais.
NodeSpan
Um intervalo da fonte para um nó da árvore: um JSON Pointer RFC 6901 que endereça o nó dentro da árvore, emparelhado com o intervalo que o localiza nos bytes originais.
| Propriedade | Tipo | Obrigatória | Descrição |
|---|---|---|---|
pointer | string | sim | Um JSON Pointer RFC 6901 na árvore, que endereça o nó que este intervalo localiza. |
span | SourceSpan | sim | O intervalo que localiza o nó endereçado nos bytes originais. |
Não são permitidas propriedades adicionais.
SourceSpan
Um intervalo dos bytes da fonte original: os deslocamentos em bytes são a localização primária e exata, e os números de linha e de coluna acompanham-nos para diagnósticos legíveis por uma pessoa.
| Propriedade | Tipo | Obrigatória | Descrição |
|---|---|---|---|
start_offset | integer | sim | O deslocamento em bytes do primeiro byte do intervalo na fonte original, a partir de zero. |
end_offset | integer | sim | O deslocamento em bytes uma posição após o último byte do intervalo na fonte original, pelo que end_offset menos start_offset é o comprimento do intervalo em bytes. |
start_line | integer | sim | O número da linha do início do intervalo, a partir de um, para diagnósticos legíveis por uma pessoa. |
start_column | integer | sim | O número da coluna do início do intervalo, a partir de um, para diagnósticos legíveis por uma pessoa. |
end_line | integer | sim | O número da linha do fim do intervalo, a partir de um, para diagnósticos legíveis por uma pessoa. |
end_column | integer | sim | O número da coluna do fim do intervalo, a partir de um, para diagnósticos legíveis por uma pessoa. |
Não são permitidas propriedades adicionais.
ParseSourceResponse
A resposta da função do anfitrião parse-source: em caso de sucesso, a árvore estruturada canónica que o analisador resolvido produziu; em caso de falha, uma mensagem de erro. Exatamente um dos dois campos é preenchido. A falha é entregue em banda em vez de através de um trap, pelo que um guest consumidor leva a ausência de analisador ou uma falha de análise para os seus próprios diagnósticos como uma falha determinística. Este é o envelope que um socket consumidor recebe quando pede ao host que execute um produtor através do host; o payload do pedido é um ParseInput.
| Propriedade | Tipo | Obrigatória | Descrição |
|---|---|---|---|
tree | any | não | A árvore estruturada canónica que o analisador resolvido produziu em caso de sucesso, como documento JSON transportado literalmente; ausente em caso de falha. Tal como na árvore própria da saída da análise, «documento JSON» designa a forma do valor, e não a codificação em que viaja. |
error | string | não | A mensagem de falha em caso de falha, que indica o formato e o motivo; ausente em caso de sucesso. |
hostfunc_error_code | string (enum) | não | A identidade da falha identificável por máquina em caso de falha, retirada do catálogo fechado de códigos de erro das funções do anfitrião, definida ao lado da mensagem de erro legível por pessoas; ausente em caso de sucesso. Esse catálogo é um vocabulário fixo que nomeia as formas como uma função do anfitrião pode falhar, e é um vocabulário diferente das condições de paragem que o compilador regista, cujos identificadores um guest reporta numa saída de socket como condition_code e condition_short_code — o nome da chave indica a qual dos dois pertence um valor, pelo que os dois nunca são lidos como um único conjunto. Um guest ramifica-se com base neste código sem analisar a mensagem, tolerando um código ausente (host mais antigo) ou um não reconhecido (host mais recente) ao recorrer à mensagem. Valores permitidos: "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" |
Não são permitidas propriedades adicionais.