Moai SDK SNAPSHOT (build 42)

MOAIStreamWriter Class Reference

MOAIStreamWriter may be attached to another stream for the purpose of encoding and/or compressing bytes written to that stream using a given algorithm (such as base64 or 'deflate').

Inheritance diagram for MOAIStreamWriter:
Collaboration diagram for MOAIStreamWriter:

List of all members.

Function List

 close
 openBase64
 openDeflate

Function Documentation

close

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


function close ( MOAIStreamWriter self )

Parameters:
self( MOAIStreamWriter )
Returns:
nil
openBase64

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


function openBase64 ( MOAIStreamWriter self, MOAIStream target )

Parameters:
self( MOAIStreamWriter )
target( MOAIStream )
Returns:
success ( boolean )
openDeflate

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


function openDeflate ( MOAIStreamWriter self, MOAIStream target )

Parameters:
self( MOAIStreamWriter )
target( MOAIStream )
Returns:
success ( boolean )