sto_erase

Conceitos

Objetos Serializados

Comportamento

C

• Analisa um STObject apontado por read_ptr
• Escreve um novo STObject em write_ptr, mas sem field_id, caso ele estivesse presente no objeto original.

JavaScript

• Procura o objeto STO (dados de ledger codificados em binário) do qual o campo será removido.
• Procura o ID do campo a ser removido.
• Retorna o objeto STO atualizado em formato de dados de ledger codificados em binário, ou um código de erro se a operação falhar.

Definição

C

int64_t sto_erase (
    uint32_t write_ptr,
    uint32_t write_len,
    uint32_t read_ptr,
    uint32_t read_len,
    uint32_t field_id
);

Codificação do Field ID

As APIs sto_ aceitam um parâmetro field_id codificado da seguinte forma: (type << 16U) + field Assim, o tipo 1 campo 2 seria 0x10002U.

JavaScript

function sto_erase(
    sto: ByteArray | HexString,
    field_id: number
  ): ErrorCode | ByteArray

Exemplo

C

int64_t result =
  sto_erase(tx_out, sizeof(tx_out),
            tx_in, tx_len, sfSigners);

if (tx_len <= 0)
    rollback("Erasing failed.", 15, 1);

Equivalência com Emplace

sto_erase é o mesmo que sto_emplace com 0,0 para os parâmetros field_ptr, field_len.

JavaScript

const tx_out = sto_erase(tx_in, sfSigners)

if (typeof tx_out === 'number')
    rollback("Erasing failed.", 1)

Parâmetros

C

Nome	Tipo	Descrição
write_ptr	uint32_t	O buffer onde o STObject modificado será escrito
write_len	uint32_t	O tamanho do buffer de saída
read_ptr	uint32_t	O buffer de onde o STObject de origem será lido
read_len	uint32_t	O tamanho do objeto de origem
field_id	uint32_t	O código sf (localização) a ser removido

JavaScript

Nome	Tipo	Descrição
sto	ByteArray | HexString	O objeto STO (dados de ledger codificados em binário) do qual o campo será removido.
field_id	number	O ID do campo a ser removido.

Código de Retorno

C

Tipo

Descrição

int64_t

O número de bytes escritos em write_ptr Se negativo, um erro: OUT_OF_BOUNDS - ponteiros/tamanhos especificados fora da memória do hook. TOO_SMALL - O buffer de saída deve ser pelo menos tão grande quanto o objeto de origem. TOO_BIG - O campo do qual você está tentando remover é muito grande PARSE_ERROR - O STObject fornecido está malformado ou não é um STObject. DOESNT_EXIST - O field_id especificado não está presente no STObject.

JavaScript

Tipo	Descrição
ErrorCode | ByteArray	O objeto STO atualizado em formato de dados de ledger codificados em binário, ou um código de erro se a operação falhar.