Pular para o conteúdo
AggregaAggrega
Selecionar língua: Português (Brasil)
Esta página foi traduzida automaticamente. Leia o original em inglês.

Esquema do socket Wasm de analisador do Aggrega

Referência gerada. Não edite à mão — gere 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 colaterais que transforma uma representação textual externa em uma árvore JSON estruturada canônica, de modo que qualquer consumidor em qualquer linguagem pode ler a árvore sem precisar carregar o seu próprio analisador da linguagem. Um analisador declara os formatos que trata como capacidades parse: no seu descritor; o host lhe entrega os bytes a analisar e o nome do formato, e ele retorna a árvore mais diagnósticos e intervalos da fonte opcionais. O analisador não atribui à árvore nenhum significado além da sua sintaxe — o compilador repassa a árvore de forma opaca.

Uma das seguintes formas

  • ParseInput
  • ParseOutput

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.

PropriedadeTipoObrigatóriaDescrição
formatstringsimO nome do formato de origem a analisar, correspondente a uma das capacidades parse: anunciadas pelo analisador (por exemplo, hcl, toml, yaml ou json). O analisador lê os bytes nesse formato.
bytesstringsimOs bytes da fonte a analisar. Cada kit os carrega no seu próprio tipo de campo — brutos onde esse tipo é um tipo de bytes, codificados em base64 onde é uma string que o analisador decodifica para recuperá-los — e o codificador gerado converte entre o campo e a forma em que o formato de transmissão carrega bytes. O analisador lê os bytes recuperados no formato nomeado.
optionsanynãoUm documento de opções opaco que o consumidor fornece para um comportamento específico do analisador. O host o repassa sem interpretá-lo; 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 retorna: a árvore estruturada canônica da fonte analisada, mais quaisquer diagnósticos que a análise levantou e quaisquer intervalos da fonte que relacionam os nós da árvore com os bytes originais.

PropriedadeTipoObrigatóriaDescrição
treeanysimA visão estruturada canônica da fonte analisada, como documento JSON. Aqui, “documento JSON” nomeia 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 trafega: a árvore é um documento JSON qualquer que seja o formato de transmissão em que este socket a carrega. O nível superior pode ser um objeto, um array ou um escalar, conforme a forma própria do documento analisado (um arquivo JSON, por exemplo, pode ser analisado como qualquer um deles). O host repassa a árvore de forma opaca, carregando-a literalmente sem interpretar o seu conteúdo.
diagnosticsDiagnostic[]nãoDiagnósticos que a análise levantou — por exemplo, um erro de sintaxe ou um aviso. Ausente quando a análise não produziu nenhum.
spansNodeSpan[]nãoIntervalos da fonte que relacionam os nós da árvore com a sua posição nos bytes originais, de modo que um consumidor pode associar um achado em um nó da árvore a uma localização na fonte. Ausente quando o analisador não relata nenhum intervalo.
errorstringnãoUma mensagem de falha definida quando o guest foi executado, mas não conseguiu concluir a operação; ausente em caso de sucesso. Ela é distinta de quaisquer diagnósticos que a saída carregue: os diagnósticos informam problemas encontrados durante uma execução que ainda assim produziu um resultado, enquanto error informa que a própria operação não foi concluída. O host apresenta um erro presente como uma invocação de plugin com falha.

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.

PropriedadeTipoObrigatóriaDescrição
pointerstringsimUm JSON Pointer RFC 6901 na árvore, que endereça o nó que este intervalo localiza.
spanSourceSpansimO 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 os acompanham para diagnósticos legíveis por uma pessoa.

PropriedadeTipoObrigatóriaDescrição
start_offsetintegersimO deslocamento em bytes do primeiro byte do intervalo na fonte original, a partir de zero.
end_offsetintegersimO deslocamento em bytes uma posição após o último byte do intervalo na fonte original, de modo que end_offset menos start_offset é o comprimento do intervalo em bytes.
start_lineintegersimO número da linha do início do intervalo, a partir de um, para diagnósticos legíveis por uma pessoa.
start_columnintegersimO número da coluna do início do intervalo, a partir de um, para diagnósticos legíveis por uma pessoa.
end_lineintegersimO número da linha do fim do intervalo, a partir de um, para diagnósticos legíveis por uma pessoa.
end_columnintegersimO 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 de host 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 por trap, de modo 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 por meio do host; o payload da requisição é um ParseInput.

PropriedadeTipoObrigatóriaDescrição
treeanynãoA árvore estruturada canônica que o analisador resolvido produziu em caso de sucesso, como documento JSON carregado literalmente; ausente em caso de falha. Assim como na árvore própria da saída da análise, “documento JSON” nomeia a forma do valor, e não a codificação em que ele trafega.
errorstringnãoA mensagem de falha em caso de falha, nomeando o formato e o motivo; ausente em caso de sucesso.
hostfunc_error_codestring (enum)nãoA identidade da falha identificável por máquina em caso de falha, extraída do catálogo fechado de códigos de erro das funções de host, 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 pelas quais uma função de host pode falhar, e é um vocabulário diferente das condições de interrupção que o compilador registra, cujos identificadores um guest informa em uma saída de socket como condition_code e condition_short_code — o nome da chave diz a qual dos dois um valor pertence, de modo que os dois nunca são lidos como um único conjunto. Um guest se ramifica 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.