Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | Public Attributes | List of all members
Mezzanine::Scripting::Lua::FlaggedBuffer Class Reference

An expanded version of the BinaryTools::BinaryBuffer to carry one tiny piece of metadata around with it. More...

#include <lua51script.h>

+ Inheritance diagram for Mezzanine::Scripting::Lua::FlaggedBuffer:
+ Collaboration diagram for Mezzanine::Scripting::Lua::FlaggedBuffer:

Public Member Functions

 FlaggedBuffer ()
 Constructor just set the extra flag to false.
 
FlaggedBufferoperator= (const BinaryBuffer &RH)
 just a passthru to BinaryBuffer::operator= More...
 
- Public Member Functions inherited from Mezzanine::BinaryTools::BinaryBuffer
 BinaryBuffer ()
 Default constructor, set everything to zero. Doesn't allocate anything.
 
 BinaryBuffer (const BinaryBuffer &Other)
 Copy constructor. More...
 
 BinaryBuffer (const Whole PredeterminedSize)
 Terse constructor, set a custom size and allocates space (filled with gibberish). More...
 
 BinaryBuffer (Byte *BinaryPointer, const Whole PredeterminedSize)
 Verbose constructor, set everything custom on creation. More...
 
 BinaryBuffer (const String &DataString, const Boole IsBase64=true)
 Base64 decoding Constructor. More...
 
 ~BinaryBuffer ()
 Virtual deconstructor calls DeleteBuffer() to clean up whatever has been inserted here. More...
 
void Concatenate (const Byte *OtherBuffer, const Whole ByteSize)
 Append another group of arbitrary data onto this one. More...
 
void Concatenate (const BinaryBuffer BufferFromAnotherMother)
 Concatenate another buffer onto this one. More...
 
void CreateBuffer ()
 This will create a buffer with size matching the this->Size and point this->Binary to that Buffer. More...
 
void CreateFromBase64 (const String &EncodedBinaryData)
 This calls deallocates any space, allocates fresh space of the size requestedthen the Decodes the passed and repopulates the Buffer. More...
 
void DeleteBuffer (const Whole NewSize=0)
 Deletes whatever Binary points at and assigns Size to 0. More...
 
Whole GetSize () const
 Even though this class is intended to have its internals modified directly in some cases, In normal cases accessor are nice to have. More...
 
BinaryBufferoperator+= (const BinaryBuffer &RH)
 Addition Assignment Operator. More...
 
BinaryBufferoperator= (const BinaryBuffer &RH)
 Assignment Operator. More...
 
Byteoperator[] (const Whole Index)
 Access a part of the buffer. More...
 
String ToBase64String ()
 Get the binary buffer as a base64 string. More...
 
String ToString ()
 Get the contents of this crudely converted to a c style string then stuff it in a string. More...
 

Public Attributes

bool Loaded
 Used to indicate that this data has been loaded into lua.
 
- Public Attributes inherited from Mezzanine::BinaryTools::BinaryBuffer
ByteBinary
 A pointer to the actual binary data.
 
Whole Size
 How many bytes is Binary in size. This is set to 0 if Binary is invalid and should be a null pointer.
 

Additional Inherited Members

- Public Types inherited from Mezzanine::BinaryTools::BinaryBuffer
typedef Int8 Byte
 The type of data this buffer can hold, it is intended to be some type one byte in length, but doesn't have to be.
 

Detailed Description

An expanded version of the BinaryTools::BinaryBuffer to carry one tiny piece of metadata around with it.

Definition at line 70 of file lua51script.h.

Member Function Documentation

FlaggedBuffer& Mezzanine::Scripting::Lua::FlaggedBuffer::operator= ( const BinaryBuffer RH)
inline

just a passthru to BinaryBuffer::operator=

Parameters
RHThe assiging binary buffer
Returns
This returns a reference to this for operator chaing and such.

Definition at line 76 of file lua51script.h.


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