utl::Base64encode Class Reference

Encode binary data using Base64 (the MIME / RFC 2045 encoding). More...

#include <Base64encoder.h>

Inheritance diagram for utl::Base64encode:

Public Member Functions
	Base64encode (utl::Stream *os, bool owner=false)
	Constructor. More...
Stream *	stream () const
	Get the output stream. More...
bool	streamOwner () const
	Get the ownership flag for the output stream. More...
void	setOutputStream (Stream *os, bool owner=false)
	Set output stream. More...
void	process (const byte_t *data, size_t dataLen)
	Process the provided data. More...
void	finalize ()
	Complete the encoding process. More...
Public Member Functions inherited from utl::Object
void	clear ()
	Revert to initial state. More...
virtual int	compare (const Object &rhs) const
	Compare with another object. More...
virtual void	copy (const Object &rhs)
	Copy another instance. More...
virtual void	vclone (const Object &rhs)
	Make an exact copy of another instance. More...
virtual void	steal (Object &rhs)
	"Steal" the internal representation from another instance. More...
virtual void	dump (Stream &os, uint_t level=uint_t_max) const
	Dump a human-readable representation of self to the given output stream. More...
void	dumpWithClassName (Stream &os, uint_t indent=4, uint_t level=uint_t_max) const
	Front-end for dump() that prints the object's class name. More...
virtual const Object &	getKey () const
	Get the key for this object. More...
bool	hasKey () const
	Determine whether or not the object has a key. More...
virtual const Object &	getProxiedObject () const
	Get the proxied object (= self if none). More...
virtual Object &	getProxiedObject ()
	Get the proxied object (= self if none). More...
virtual size_t	hash (size_t size) const
	Get the hash code for the object. More...
bool	_isA (const RunTimeClass *runTimeClass) const
	Determine whether self's class is a descendent of the given class. More...
virtual String	toString () const
	Return a string representation of self. More...
	operator String () const
	Conversion to String. More...
size_t	allocatedSize () const
	Get the total allocated size of this object. More...
virtual size_t	innerAllocatedSize () const
	Get the "inner" allocated size. More...
virtual void	addOwnedIt (const class FwdIt *it) const
	Notify self that it owns the given iterator. More...
virtual void	removeOwnedIt (const class FwdIt *it) const
	Notify self that the given owned iterator has been destroyed. More...
bool	operator< (const Object &rhs) const
	Less-than operator. More...
bool	operator<= (const Object &rhs) const
	Less-than-or-equal-to operator. More...
bool	operator> (const Object &rhs) const
	Greater-than operator. More...
bool	operator>= (const Object &rhs) const
	Greater-than-or-equal-to operator. More...
bool	operator== (const Object &rhs) const
	Equal-to operator. More...
bool	operator!= (const Object &rhs) const
	Unequal-to operator. More...
void	serializeIn (Stream &is, uint_t mode=ser_default)
	Serialize from an input stream. More...
void	serializeOut (Stream &os, uint_t mode=ser_default) const
	Serialize to an output stream. More...
virtual void	serialize (Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize to or from a stream. More...
void	serializeOutBoxed (Stream &os, uint_t mode=ser_default) const
	Serialize a boxed object to an output stream. More...

Additional Inherited Members
Static Public Member Functions inherited from utl::Object
static Object *	serializeInNullable (Stream &is, uint_t mode=ser_default)
	Serialize a nullptr-able object from an input stream. More...
static void	serializeOutNullable (const Object *object, Stream &os, uint_t mode=ser_default)
	Serialize a nullptr-able object to an output stream. More...
static void	serializeNullable (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize a nullptr-able object to or from a stream. More...
static Object *	serializeInBoxed (Stream &is, uint_t mode=ser_default)
	Serialize a boxed object from an input stream. More...
static void	serializeBoxed (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize a boxed object to or from a stream. More...

Detailed Description

Encode binary data using Base64 (the MIME / RFC 2045 encoding).

This encoder doesn't place a limit on line-length, so if you want to limit line-length, you need to feed line-sized chunks to the encoder and insert the newlines yourself. You would feed data to the encoder in multiples of 3 bytes. 3 bytes of input map to 4 base-64 (6-bit) digits. For example if you write a newline after every 60 bytes of input, you'll have 80 base-64 digits per output line.

Author

Adam McKee

Definition at line 30 of file Base64encoder.h.

Constructor & Destructor Documentation

Base64encode()

utl::Base64encode::Base64encode ( utl::Stream *  os, bool  owner = false  )

inline

Constructor.

Parameters

os	output stream for encoded data
owner	(optional : false) ownership flag for output stream

Definition at line 42 of file Base64encoder.h.

References utl::init().

Member Function Documentation

stream()

Stream* utl::Base64encode::stream ( ) const

inline

Get the output stream.

Definition at line 50 of file Base64encoder.h.

streamOwner()

bool utl::Base64encode::streamOwner ( ) const

inline

Get the ownership flag for the output stream.

Definition at line 57 of file Base64encoder.h.

setOutputStream()

void utl::Base64encode::setOutputStream ( Stream *  os, bool  owner = false  )

inline

Set output stream.

Parameters

os	output stream
owner	ownership flag for output stream

Definition at line 68 of file Base64encoder.h.

References utl::deInit(), and utl::init().

process()

void utl::Base64encode::process	(	const byte_t *	data,
		size_t	dataLen
	)

Process the provided data.

finalize()

void utl::Base64encode::finalize

(

)

Complete the encoding process.

---

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

• Base64encoder.h