Encoder

Inherits: Class

Methods

Deserialize

function Encoder:Deserialize(str)
  -> boolean, ...any

Decodes, decompresses, and deserializes the given data.

Parameters:

Name	Type	Description
str	string	The data to deserialize

Returns:

Name	Type	Description
success	boolean
``	...any

Serialize

function Encoder:Serialize(...)
  -> string

Serializes, compresses, and encodes the given data.

Parameters:

Name	Type	Description
...	any	The data to serialize

Returns:

Type	Description
string

SetEncodingType

function Encoder:SetEncodingType(encodingType)
  -> self

Sets the encoding type to use.

Parameters:

Name	Type	Description
encodingType	EncoderEncodingType

Returns:

Type	Description
self

SetSerializationFilter

function Encoder:SetSerializationFilter(func)
  -> self

Sets a serialization filter function.

Parameters:

Name	Type	Description
func	fun(tbl: table, k: any, v: any): boolean	The filter function

Returns:

Type	Description
self

SetSerializationType

function Encoder:SetSerializationType(serializationType)
  -> self

Sets the serialization type to use.

Parameters:

Name	Type	Description
serializationType	EncoderSerializationType

Returns:

Type	Description
self

Functions

Create

function Encoder.Create()
  -> Encoder

Creates an encoder.

Returns:

Type	Description
Encoder