sto_erase

Conceptos

Objetos Serializados

Comportamiento

C

• Parsea un STObject apuntado por read_ptr
• Escribe un nuevo STObject en write_ptr pero sin el field_id si estaba presente en el objeto original

JavaScript

• Busca el objeto STO (datos del ledger codificados en binario) del cual se eliminará el campo
• Busca el identificador del campo a eliminar
• Devuelve el objeto STO actualizado en formato binario, o un código de error si falla

Definición

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
);

Codificación del Field ID

Las APIs sto_ aceptan un parámetro field_id codificado así: (type << 16U) + field Por ejemplo, tipo 1 campo 2 sería 0x10002U.

JavaScript

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

Ejemplo

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);

Equivalencia con Emplace

sto_erase es equivalente a sto_emplace usando 0,0 como 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

Nombre	Tipo	Descripción
write_ptr	uint32_t	Buffer donde se escribirá el STObject modificado
write_len	uint32_t	Longitud del buffer de salida
read_ptr	uint32_t	Buffer que contiene el STObject origen
read_len	uint32_t	Longitud del objeto origen
field_id	uint32_t	Código sf (posición) del campo a eliminar

JavaScript

Nombre	Tipo	Descripción
sto	ByteArray | HexString	Objeto STO (datos binarios del ledger) del que se eliminará el campo
field_id	number	Identificador del campo a eliminar

Código de retorno

C

Tipo	Descripción
int64_t	Número de bytes escritos en write_ptr Si es negativo, error: OUT_OF_BOUNDS - punteros fuera de la memoria del hook TOO_SMALL - el buffer debe ser al menos tan grande como el objeto origen TOO_BIG - el campo a eliminar es demasiado grande PARSE_ERROR - el STObject es inválido o mal formado DOESNT_EXIST - el field_id no existe en el STObject

JavaScript

Tipo	Descripción
ErrorCode | ByteArray	Objeto STO actualizado en formato binario, o un código de error si la operación falla