Go API Reference

Below are the Go API reference for the Sia serialization library.

Constructor

Creates a new Sia instance.

Attributes

Name	Description
Content	The current content of the Sia instance.
Index	The current offset of the Sia instance pointer.

Methods

Name	Description
Seek	Changes the offset of the Sia instance pointer.
Bytes	Returns the current content of the Sia instance.
Offset	Returns the current offset of the Sia instance pointer.
EmbedSia	Adds the content of the provided Sia instance to the current content.
EmbedBytes	Adds the provided bytes to the current content.
AddBigInt	Adds the provided big integer to the current content.
AddBool	Adds the provided boolean to the current content.
AddUInt8	Adds the provided unsigned 8-bit integer to the current content.
AddUInt16	Adds the provided unsigned 16-bit integer to the current content.
AddUInt32	Adds the provided unsigned 32-bit integer to the current content.
AddUInt64	Adds the provided unsigned 64-bit integer to the current content.
AddInt8	Adds the provided signed 8-bit integer to the current content.
AddInt16	Adds the provided signed 16-bit integer to the current content.
AddInt32	Adds the provided signed 32-bit integer to the current content.
AddInt64	Adds the provided signed 64-bit integer to the current content.
AddStringN	Adds the provided null-terminated UTF-8 string to the current content.
AddString8	Adds the provided ASCII string to the current content.
AddString16	Adds the provided UTF-16 string to the current content.
AddString32	Adds the provided UTF-32 string to the current content.
AddString64	Adds the provided UTF-64 string to the current content.
AddByteArrayN	Adds the provided byte array to the current content.
AddByteArray8	Adds the provided byte array to the current content.
AddByteArray16	Adds the provided byte array to the current content.
AddByteArray32	Adds the provided byte array to the current content.
AddByteArray64	Adds the provided byte array to the current content.
ReadBigInt	Reads a big integer from the current content.
ReadBool	Reads a boolean from the current content.
ReadUInt8	Reads an unsigned 8-bit integer from the current content.
ReadUInt16	Reads an unsigned 16-bit integer from the current content.
ReadUInt32	Reads an unsigned 32-bit integer from the current content.
ReadUInt64	Reads an unsigned 64-bit integer from the current content.
ReadInt8	Reads a signed 8-bit integer from the current content.
ReadInt16	Reads a signed 16-bit integer from the current content.
ReadInt32	Reads a signed 32-bit integer from the current content.
ReadInt64	Reads a signed 64-bit integer from the current content.
ReadStringN	Reads a null-terminated UTF-8 string from the current content.
ReadString8	Reads an ASCII string from the current content.
ReadString16	Reads a UTF-16 string from the current content.
ReadString32	Reads a UTF-32 string from the current content.
ReadString64	Reads a UTF-64 string from the current content.
ReadByteArrayN	Reads a byte array from the current content.
ReadByteArray8	Reads an 8-bit byte array from the current content.
ReadByteArray16	Reads a 16-bit byte array from the current content.
ReadByteArray32	Reads a 32-bit byte array from the current content.
ReadByteArray64	Reads a 64-bit byte array from the current content.

Utility Methods

Seek

Changes the offset of the Sia instance pointer.

Bytes

Returns the current content of the Sia instance.

Offset

Returns the current offset of the Sia instance pointer.

EmbedSia

Adds the content of the provided Sia instance to the current content.

EmbedBytes

Adds the provided bytes to the current content.

Add Methods

AddBigInt

Adds the provided big integer to the current content.

AddBool

Adds the provided boolean to the current content.

AddUInt8

Adds the provided unsigned 8-bit integer to the current content.

AddUInt16

Adds the provided unsigned 16-bit integer to the current content.

AddUInt32

Adds the provided unsigned 32-bit integer to the current content.

AddUInt64

Adds the provided unsigned 64-bit integer to the current content.

AddInt8

Adds the provided signed 8-bit integer to the current content.

AddInt16

Adds the provided signed 16-bit integer to the current content.

AddInt32

Adds the provided signed 32-bit integer to the current content.

AddInt64

Adds the provided signed 64-bit integer to the current content.

AddStringN

Adds the provided null-terminated UTF-8 string to the current content.

AddString8

Adds the provided ASCII string to the current content.

AddString16

Adds the provided UTF-16 string to the current content.

AddString32

Adds the provided UTF-32 string to the current content.

AddString64

Adds the provided UTF-64 string to the current content.

AddByteArrayN

Adds the provided byte array to the current content.

AddByteArray8

Adds the provided byte array to the current content.

AddByteArray16

Adds the provided byte array to the current content.

AddByteArray32

Adds the provided byte array to the current content.

AddByteArray64

Adds the provided byte array to the current content.

Read Methods

ReadBigInt

Reads a big integer from the current content.

ReadBool

Reads a boolean from the current content.

ReadUInt8

Reads an unsigned 8-bit integer from the current content.

ReadUInt16

Reads an unsigned 16-bit integer from the current content.

ReadUInt32

Reads an unsigned 32-bit integer from the current content.

ReadUInt64

Reads an unsigned 64-bit integer from the current content.

ReadInt8

Reads a signed 8-bit integer from the current content.

ReadInt16

Reads a signed 16-bit integer from the current content.

ReadInt32

Reads a signed 32-bit integer from the current content.

ReadInt64

Reads a signed 64-bit integer from the current content.

ReadStringN

Reads a null-terminated UTF-8 string from the current content.

ReadString8

Reads an ASCII string from the current content.

ReadString16

Reads a UTF-16 string from the current content.

ReadString32

Reads a UTF-32 string from the current content.