Aptos.BCS.Serialization Class Reference

An implementation of BCS Serialization in C#. More...

Public Member Functions
byte[]	GetBytes ()
	Return the serialization buffer as a byte array.
Serialization	Serialize (string value)
	Serialize a string value.
Serialization	Serialize (byte[] value)
	Serialize a byte array.
Serialization	Serialize (bool value)
	Serialize a boolean value.
Serialization	Serialize (byte num)
	Serialize a single byte.
Serialization	Serialize (ushort num)
	Serialize an unsigned short value.
Serialization	Serialize (uint num)
	Serialize an unsigned integer value.
Serialization	Serialize (ulong num)
	Serialize an unsigned long number.
Serialization	Serialize (BigInteger num)
	Serialize a big integer number.
Serialization	Serialize (ISerializable value)
	Serializes an object using it's own serialization implementation.
Serialization	Serialize (Sequence args)
	Serialize a plain sequence as a list of bytes.
Serialization	Serialize (ISerializable[] args)
	Serializes an array of serializable elements.
Serialization	SerializeString (string value)
	Serializes a string. UTF8 string is supported. Serializes the string's bytes length "l" first, and then serializes "l" bytes of the string content.
Serialization	SerializeBytes (byte[] bytes)
	Serializes an array of bytes. BCS layout for "bytes": bytes_length | bytes. bytes_length is the length of the bytes array that is uleb128 encoded. bytes_length is a u32 integer.
Serialization	SerializeFixedBytes (byte[] bytes)
	Serializes a list of values represented in a byte array. This can be a sequence or a value represented as a byte array. Note that for sequences we first add the length for the entire sequence array, not the length of the byte array.
Serialization	WriteBytes (byte[] bytes)
	Write an array bytes directly to the serialization buffer.
Serialization	SerializeU32AsUleb128 (uint value)
	Serialize an unsigned integer value. Usually used to serialize the length of values.
Serialization	SerializeBool (bool value)
	Serialize a boolean value.
Serialization	SerializeU8 (byte num)
	Serialize a unsigned byte number.
Serialization	SerializeU16 (ushort num)
	Serialize unsigned short (U16).
Serialization	SerializeU32 (uint num)
	Serialize an unsigned integer number.
Serialization	SerializeU64 (ulong num)
	Serialize an unsigned long number.
Serialization	SerializeU128 (BigInteger value)
	Serialize a big integer value.
Serialization	SerializeU256 (BigInteger value)
	Serialize a unsigned 256 int (big integer) value.

Static Public Member Functions
static string	ToReadableByteArray (byte[] bytes)
	Utility method to print a byte array.

Protected Attributes
MemoryStream	output

Detailed Description

An implementation of BCS Serialization in C#.

Member Function Documentation

GetBytes()

byte[] Aptos.BCS.Serialization.GetBytes ( )

inline

Return the serialization buffer as a byte array.

Returns

Serialization buffer as a byte array.

Serialize() [1/11]

Serialization Aptos.BCS.Serialization.Serialize ( BigInteger  num )

inline

Serialize a big integer number.

Parameters

num	The big integer number to serialize.

Returns

The current Serialization object.

Serialize() [2/11]

Serialization Aptos.BCS.Serialization.Serialize ( bool  value )

inline

Serialize a boolean value.

Parameters

value

Boolean value to serialize.

Returns

The current Serialization object.

Serialize() [3/11]

Serialization Aptos.BCS.Serialization.Serialize ( byte  num )

inline

Serialize a single byte.

Parameters

num	Byte to serialize.

Returns

The current Serialization object.

Serialize() [4/11]

Serialization Aptos.BCS.Serialization.Serialize ( byte[]  value )

inline

Serialize a byte array.

Parameters

value

Byte array to serialize.

Returns

The current Serialization object.

Serialize() [5/11]

Serialization Aptos.BCS.Serialization.Serialize ( ISerializable  value )

inline

Serializes an object using it's own serialization implementation.

Parameters

value

Value to serialize

Returns

The current Serialization object.

Serialize() [6/11]

Serialization Aptos.BCS.Serialization.Serialize ( ISerializable[]  args )

inline

Serializes an array of serializable elements.

Parameters

args

Returns

Serialize() [7/11]

Serialization Aptos.BCS.Serialization.Serialize ( Sequence  args )

inline

Serialize a plain sequence as a list of bytes.

Parameters

args	The sequence to serialize.

Returns

The current Serialization object.

Serialize() [8/11]

Serialization Aptos.BCS.Serialization.Serialize ( string  value )

inline

Serialize a string value.

Parameters

value

String value to serialize.

Returns

The current Serialization object.

Serialize() [9/11]

Serialization Aptos.BCS.Serialization.Serialize ( uint  num )

inline

Serialize an unsigned integer value.

Parameters

num	The unsigned integer to serialize.

Returns

The current Serialization object.

Serialize() [10/11]

Serialization Aptos.BCS.Serialization.Serialize ( ulong  num )

inline

Serialize an unsigned long number.

Parameters

num	The unsigned long number to serialize.

Returns

The current Serialization object.

Serialize() [11/11]

Serialization Aptos.BCS.Serialization.Serialize ( ushort  num )

inline

Serialize an unsigned short value.

Parameters

num	The number to serialize.

Returns

The current Serialization object.

SerializeBool()

Serialization Aptos.BCS.Serialization.SerializeBool ( bool  value )

inline

Serialize a boolean value.

Parameters

value

Boolean value to serialize.

Returns

The current Serialization object.

SerializeBytes()

Serialization Aptos.BCS.Serialization.SerializeBytes ( byte[]  bytes )

inline

Serializes an array of bytes. BCS layout for "bytes": bytes_length | bytes. bytes_length is the length of the bytes array that is uleb128 encoded. bytes_length is a u32 integer.

Parameters

bytes

Byte array to serialize.

Returns

The current Serialization object.

SerializeFixedBytes()

Serialization Aptos.BCS.Serialization.SerializeFixedBytes ( byte[]  bytes )

inline

Serializes a list of values represented in a byte array. This can be a sequence or a value represented as a byte array. Note that for sequences we first add the length for the entire sequence array, not the length of the byte array.

Parameters

bytes

Byte array to be serialized.

Returns

The current Serialization object.

SerializeString()

Serialization Aptos.BCS.Serialization.SerializeString ( string  value )

inline

Serializes a string. UTF8 string is supported. Serializes the string's bytes length "l" first, and then serializes "l" bytes of the string content.

BCS layout for "string": string_length | string_content. string_length is the bytes length of the string that is uleb128 encoded. string_length is a u32 integer.

Parameters

value

String value to serialize.

Returns

The current Serialization object.

SerializeU128()

Serialization Aptos.BCS.Serialization.SerializeU128 ( BigInteger  value )

inline

Serialize a big integer value.

Parameters

value

Big integer value to serialize.

Returns

The current Serialization object.

SerializeU16()

Serialization Aptos.BCS.Serialization.SerializeU16 ( ushort  num )

inline

Serialize unsigned short (U16).

Parameters

num	Unsigned short number to serialize.

Returns

The current Serialization object.

SerializeU256()

Serialization Aptos.BCS.Serialization.SerializeU256 ( BigInteger  value )

inline

Serialize a unsigned 256 int (big integer) value.

Parameters

value

Big integer value to serialize.

Returns

The current Serialization object.

SerializeU32()

Serialization Aptos.BCS.Serialization.SerializeU32 ( uint  num )

inline

Serialize an unsigned integer number.

Parameters

num	Unsigned integer number.

Returns

The current Serialization object.

SerializeU32AsUleb128()

Serialization Aptos.BCS.Serialization.SerializeU32AsUleb128 ( uint  value )

inline

Serialize an unsigned integer value. Usually used to serialize the length of values.

Parameters

value

Unsigned integer to serialize.

Returns

The current Serialization object.

SerializeU64()

Serialization Aptos.BCS.Serialization.SerializeU64 ( ulong  num )

inline

Serialize an unsigned long number.

Parameters

num	Unsigned long number to serialize.

Returns

The current Serialization object.

SerializeU8()

Serialization Aptos.BCS.Serialization.SerializeU8 ( byte  num )

inline

Serialize a unsigned byte number.

Parameters

num	Byte to serialize.

Returns

The current Serialization object.

ToReadableByteArray()

static string Aptos.BCS.Serialization.ToReadableByteArray ( byte[]  bytes )

inlinestatic

Utility method to print a byte array.

Parameters

bytes

Byte array to turn into string.

Returns

String representation of a byte array.

WriteBytes()

Serialization Aptos.BCS.Serialization.WriteBytes ( byte[]  bytes )

inline

Write an array bytes directly to the serialization buffer.

Parameters

bytes

Byte array to write to the serialization buffer.

Returns

The current Serialization object.

---

The documentation for this class was generated from the following file:

• Aptos.BCS/Serialization.cs