tagion.api.document

API for using document

Members

Enums

DocumentTextFormat
enum DocumentTextFormat

Format to use for tagion_document_get_text

Functions

tagion_document_element_by_index
int tagion_document_element_by_index(uint8_t* buf, size_t buf_len, size_t index, Document.Element* element)

Get a document element from index

tagion_document_element_by_key
int tagion_document_element_by_key(uint8_t* buf, size_t buf_len, char* key, size_t key_len, Document.Element* element)

Get a Document element by a key

tagion_document_get_bigint
int tagion_document_get_bigint(Document.Element* element, uint8_t** bigint_buf, size_t* bigint_buf_len)

Get bigint from a document. Returned as serialized leb128 ubyte buffer

tagion_document_get_bool
int tagion_document_get_bool(Document.Element* element, bool* value)

Get a bool from a document element

tagion_document_get_document
int tagion_document_get_document(Document.Element* element, uint8_t** buf, size_t* buf_len)

Get an sub doc from a document

tagion_document_get_float32
int tagion_document_get_float32(Document.Element* element, float* value)

Get an f32 from a document element

tagion_document_get_float64
int tagion_document_get_float64(Document.Element* element, double* value)

Get an f64 from a document element

tagion_document_get_int32
int tagion_document_get_int32(Document.Element* element, int32_t* value)

Get an i32 from a document element

tagion_document_get_int64
int tagion_document_get_int64(Document.Element* element, long* value)

Get an i64 from a document element

tagion_document_get_record_name
int tagion_document_get_record_name(uint8_t* buf, size_t buf_len, char** record_name, size_t* record_name_len)

Get document record type name of a document

tagion_document_get_string
int tagion_document_get_string(Document.Element* element, char** value, size_t* str_len)

Get an element string value

tagion_document_get_text
int tagion_document_get_text(uint8_t* buf, size_t buf_len, int text_format, char** str, size_t* str_len)

Get document as string

tagion_document_get_time
int tagion_document_get_time(Document.Element* element, long* time)

Get time from a document element

tagion_document_get_u8_array
int tagion_document_get_u8_array(Document.Element* element, uint8_t** buf, size_t* buf_len)

Get binary from a document

tagion_document_get_uint32
int tagion_document_get_uint32(Document.Element* element, uint32_t* value)

Get an uint32 from a document element

tagion_document_get_uint64
int tagion_document_get_uint64(Document.Element* element, ulong* value)

Get an uint64 from a document element

tagion_document_get_version
int tagion_document_get_version(uint8_t* buf, size_t buf_len, uint32_t* ver)

Return the version of the document

tagion_document_valid
int tagion_document_valid(uint8_t* buf, size_t buf_len, int32_t* doc_error_code)

Get document error code