Moai SDK  2.0
MOAIStreamAdapter Class Reference
+ Inheritance diagram for MOAIStreamAdapter:

Function List

close
 
openBase64Reader
 
openBase64Writer
 
openDeflateReader
 
openDeflateWriter
 
openHex
 

Additional Inherited Members

- Function List inherited from MOAIStream
collapse
 
compact
 
flush
 
getCursor
 
getLength
 
read
 
read8
 
read16
 
read32
 
readBoolean
 
readDouble
 
readFloat
 
readFormat
 
readU8
 
readU16
 
readU32
 
seek
 
write
 
write8
 
write16
 
write32
 
writeBoolean
 
writeColor32
 
writeDouble
 
writeFloat
 
writeFormat
 
writeStream
 
writeU8
 
writeU16
 
writeU32
 

Function Documentation

close

Flush any remaining buffered data (if a write) and detach the target stream. (This only detaches the target from the formatter; it does not also close the target stream).


function close ( MOAIStreamWriter self )

Parameters
MOAIStreamWriterself
Returns
nil
openBase64Reader

Open a base 64 formatted stream for reading (i.e. decode bytes from base64).


function openBase64 ( MOAIStreamAdapter self, MOAIStream target )

Parameters
MOAIStreamAdapterself
MOAIStreamtarget
Returns
boolean success
openBase64Writer

Open a base 64 formatted stream for writing (i.e. encode bytes to base64).


function openBase64Writer ( MOAIStreamAdapter self, MOAIStream target )

Parameters
MOAIStreamAdapterself
MOAIStreamtarget
Returns
boolean success
openDeflateReader

Open a 'deflate' formatted stream for reading (i.e. decompress bytes using the 'deflate' algorithm).


function openDeflate ( MOAIStreamAdapter self, MOAIStream target [, number windowBits ] )

Parameters
MOAIStreamAdapterself
MOAIStreamtarget
numberwindowBits Optional. The window bits used in the DEFLATE algorithm.
Returns
boolean success
openDeflateWriter

Open a 'deflate' formatted stream for writing (i.e. compress bytes using the 'deflate' algorithm).


function openDeflateWriter ( MOAIStreamAdapter self, MOAIStream target [, number level, number windowBits ] )

Parameters
MOAIStreamAdapterself
MOAIStreamtarget
numberlevel Optional. The level used in the DEFLATE algorithm.
numberwindowBits Optional. The window bits used in the DEFLATE algorithm.
Returns
boolean success
openHex

Open a hex formatted stream for reading and writing (i.e. decode and encode bytes to and from hex).


function openHex ( MOAIStreamReader self, MOAIStream target )

Parameters
MOAIStreamReaderself
MOAIStreamtarget
Returns
boolean success