Inherits MOAILuaObject.

Function List
	base64Decode

	base64Encode

	clear

	deflate

	getSize

	getString

	hexDecode

	hexEncode

	inflate

	load

	loadAsync

	save

	saveAsync

	setString

	toCppHeader

Function Documentation

base64Decode

If a string is provided, decodes it as a base64 encoded string. Otherwise, decodes the current data stored in this object as a base64 encoded sequence of characters.

function base64Decode ( [ MOAIDataBuffer self, string data ] )

Parameters

MOAIDataBuffer	self Optional.
string	data Optional. The string data to decode. You must either provide either a MOAIDataBuffer (via a :base64Decode type call) or string data (via a .base64Decode type call), but not both.

Returns: string output

base64Encode

If a string is provided, encodes it in base64. Otherwise, encodes the current data stored in this object as a base64 encoded sequence of characters.

function base64Encode ( [ MOAIDataBuffer self, string data ] )

Parameters

MOAIDataBuffer	self Optional.
string	data Optional. The string data to encode. You must either provide either a MOAIDataBuffer (via a :base64Encode type call) or string data (via a .base64Encode type call), but not both.

Returns: string output

clear

Release the data buffer's memory.

function clear ( MOAIDataBuffer self )

Parameters

MOAIDataBuffer self

Returns: nil

deflate

Compresses the string or the current data stored in this object using the DEFLATE algorithm.

function deflate ( string data [, number level, number windowBits ] )

Parameters

string	data The string data to deflate.
number	level Optional. The level used in the DEFLATE algorithm.
number	windowBits Optional. The window bits used in the DEFLATE algorithm.

Returns: string output

Note

function deflate ( MOAIDataBuffer self [, number level, number windowBits ] )

Parameters

MOAIDataBuffer	self
number	level Optional. The level used in the DEFLATE algorithm.
number	windowBits Optional. The window bits used in the DEFLATE algorithm.

Returns: string output

Note

getSize

Returns the number of bytes in this data buffer object.

function getSize ( MOAIDataBuffer self )

Parameters

MOAIDataBuffer self

Returns: number size

getString

Returns the contents of the data buffer object as a string value.

function getString ( MOAIDataBuffer self )

Parameters

MOAIDataBuffer self

Returns: string data

hexDecode

If a string is provided, decodes it as a hex encoded string. Otherwise, decodes the current data stored in this object as a hex encoded sequence of bytes.

function hexDecode ( [ MOAIDataBuffer self, string data ] )

Parameters

MOAIDataBuffer	self Optional.
string	data Optional. The string data to decode. You must either provide either a MOAIDataBuffer (via a :hexDecode type call) or string data (via a .hexDecode type call), but not both.

Returns: string output

hexEncode

If a string is provided, encodes it in hex. Otherwise, encodes the current data stored in this object as a hex encoded sequence of characters.

function hexEncode ( [ MOAIDataBuffer self, string data ] )

Parameters

MOAIDataBuffer	self Optional.
string	data Optional. The string data to encode. You must either provide either a MOAIDataBuffer (via a :hexEncode type call) or string data (via a .hexEncode type call), but not both.

Returns: string output

inflate

Decompresses the string or the current data stored in this object using the DEFLATE algorithm.

function inflate ( string data [, number windowBits ] )

Parameters

string	data The string data to inflate.
number	windowBits Optional. The window bits used in the DEFLATE algorithm.

Returns: string output

Note

function inflate ( MOAIDataBuffer self [, number windowBits ] )

Parameters

MOAIDataBuffer	self
number	windowBits Optional. The window bits used in the DEFLATE algorithm.

Returns: string output

Note

load

Copies the data from the given file into this object. This method is a synchronous operation and will block until the file is loaded.

function load ( MOAIDataBuffer self, string filename [, number detectZip, number windowBits ] )

Parameters

MOAIDataBuffer	self
string	filename The path to the file that the data should be loaded from.
number	detectZip Optional. One of MOAIDataBuffer.NO_INFLATE, MOAIDataBuffer.FORCE_INFLATE, MOAIDataBuffer.INFLATE_ON_EXT
number	windowBits Optional. The window bits used in the DEFLATE algorithm. Pass nil to use the default value.

Returns: boolean success

loadAsync

Asynchronously copies the data from the given file into this object. This method is an asynchronous operation and will return immediately.

function loadAsync ( MOAIDataBuffer self, string filename, MOAITaskQueue queue [, function callback, number detectZip, boolean inflateAsync, number windowBits ] )

Parameters

MOAIDataBuffer	self
string	filename The path to the file that the data should be loaded from.
MOAITaskQueue	queue The queue to perform the loading operation.
function	callback Optional. The function to be called when the asynchronous operation is complete. The MOAIDataBuffer is passed as the first parameter.
number	detectZip Optional. One of MOAIDataBuffer.NO_INFLATE, MOAIDataBuffer.FORCE_INFLATE, MOAIDataBuffer.INFLATE_ON_EXT
boolean	inflateAsync Optional. 'true' to inflate on task thread. 'false' to inflate on subscriber thread. Default value is 'true.'
number	windowBits Optional. The window bits used in the DEFLATE algorithm. Pass nil to use the default value.

Returns: nil

save

Saves the data in this object to the given file. This method is a synchronous operation and will block until the data is saved.

function save ( MOAIDataBuffer self, string filename )

Parameters

MOAIDataBuffer	self
string	filename The path to the file that the data should be saved to.

Returns: boolean success

saveAsync

Asynchronously saves the data in this object to the given file. This method is an asynchronous operation and will return immediately.

function saveAsync ( MOAIDataBuffer self, string filename, MOAITaskQueue queue [, function callback ] )

Parameters

MOAIDataBuffer	self
string	filename The path to the file that the data should be saved to.
MOAITaskQueue	queue The queue to perform the saving operation.
function	callback Optional. The function to be called when the asynchronous operation is complete. The MOAIDataBuffer is passed as the first parameter.

Returns: nil

setString

Replaces the contents of this object with the string specified.

function setString ( MOAIDataBuffer self, string data )

Parameters

MOAIDataBuffer	self
string	data The string data to replace the contents of this object with.

Returns: nil

toCppHeader

Convert data to CPP header file.

function toCppHeader ( string data, string name [, number columns ] )

Parameters

string	data The string data to encode
string	name
number	columns Optional. Default value is 12

Returns: string output

Note

function toCppHeader ( MOAIDataBuffer data, string name [, number columns ] )

Parameters

MOAIDataBuffer	data The data buffer to encode
string	name
number	columns Optional. Default value is 12

Returns: string output

Note

Function List

Function Documentation