Urho3D::Base64OutputArchive Class Reference

Base64 output archive. More...

#include <Urho3D/IO/Base64Archive.h>

Inheritance diagram for Urho3D::Base64OutputArchive:

Public Member Functions
	Base64OutputArchive (Context *context)
ea::string	GetBase64 () const
	Return base64-encoded result.
Public Member Functions inherited from Urho3D::BinaryOutputArchive
	BinaryOutputArchive (Context *context, Serializer &serializer)
ea::string_view	GetName () const final
	Return name of the archive if applicable.
unsigned	GetChecksum () final
	Return a checksum if applicable.
void	BeginBlock (const char *name, unsigned &sizeHint, bool safe, ArchiveBlockType type) final
void	EndBlock () noexcept final
	End archive block. May postpone ArchiveException until later.
void	Serialize (const char *name, bool &value) final
void	Serialize (const char *name, signed char &value) final
void	Serialize (const char *name, unsigned char &value) final
void	Serialize (const char *name, short &value) final
void	Serialize (const char *name, unsigned short &value) final
void	Serialize (const char *name, int &value) final
void	Serialize (const char *name, unsigned int &value) final
void	Serialize (const char *name, long long &value) final
void	Serialize (const char *name, unsigned long long &value) final
void	Serialize (const char *name, float &value) final
void	Serialize (const char *name, double &value) final
void	Serialize (const char *name, ea::string &value) final
void	SerializeBytes (const char *name, void *bytes, unsigned size) final
	Serialize bytes. Size is not encoded and should be provided externally!
void	SerializeVLE (const char *name, unsigned &value) final
	Serialize Variable Length Encoded unsigned integer, up to 29 significant bits.
Public Member Functions inherited from Urho3D::ArchiveBaseT< BinaryOutputArchiveBlock, IsInputBool, false >
bool	IsInput () const final
bool	IsHumanReadable () const final
bool	IsUnorderedAccessSupportedInCurrentBlock () const final
bool	HasElementOrBlock (const char *name) const final
ea::string	GetCurrentBlockPath () const final
	Return current string stack.
void	EndBlock () noexcept override
	End archive block. May postpone ArchiveException until later.
Public Member Functions inherited from Urho3D::ArchiveBase
Context *	GetContext () final
	Get context.
bool	IsEOF () const final
	Whether the archive can no longer be serialized.
void	Flush () final
	Flush all pending events. Should be called at least once before destructor.
unsigned	SerializeVersion (unsigned version) final
	Serialize version number. 0 is invalid version.
ArchiveException	IOFailureException (ea::string_view elementName) const
ArchiveException	DuplicateElementException (ea::string_view elementName) const
ArchiveException	ElementNotFoundException (ea::string_view elementName) const
ArchiveException	ElementNotFoundException (ea::string_view elementName, unsigned elementIndex) const
ArchiveException	UnexpectedElementValueException (ea::string_view elementName) const
ArchiveException	UnexpectedEOFException (ea::string_view elementName) const
Public Member Functions inherited from Urho3D::Archive
virtual bool	IsInput () const =0
virtual bool	IsHumanReadable () const =0
virtual bool	IsUnorderedAccessSupportedInCurrentBlock () const =0
virtual ea::string	GetCurrentBlockPath () const =0
	Return current string stack.
ArchiveBlock	OpenBlock (const char *name, unsigned sizeHint, bool safe, ArchiveBlockType type)
ArchiveBlock	OpenSequentialBlock (const char *name)
	Open Sequential block. Will be automatically closed when returned object is destroyed. More...
ArchiveBlock	OpenUnorderedBlock (const char *name)
	Open Unordered block. Will be automatically closed when returned object is destroyed.
ArchiveBlock	OpenArrayBlock (const char *name, unsigned sizeHint=0)
	Open Array block. Will be automatically closed when returned object is destroyed.
ArchiveBlock	OpenSafeSequentialBlock (const char *name)
	Open safe Sequential block. Will be automatically closed when returned object is destroyed.
ArchiveBlock	OpenSafeUnorderedBlock (const char *name)
	Open safe Unordered block. Will be automatically closed when returned object is destroyed.

Additional Inherited Members
Static Public Member Functions inherited from Urho3D::Archive
static bool	ValidateName (ea::string_view name)
	Validate element or block name.
Protected Types inherited from Urho3D::ArchiveBaseT< BinaryOutputArchiveBlock, IsInputBool, false >
using	Block = BinaryOutputArchiveBlock
Protected Member Functions inherited from Urho3D::BinaryArchiveBase< BinaryOutputArchiveBlock, false >
void	CheckResult (bool result, const char *elementName) const
Protected Member Functions inherited from Urho3D::ArchiveBaseT< BinaryOutputArchiveBlock, IsInputBool, false >
Block &	GetCurrentBlock ()
const Block &	GetCurrentBlock () const
void	CheckIfRootBlockOpen () const
void	CheckBeforeBlock (const char *elementName)
void	CheckBeforeElement (const char *elementName)
	ArchiveBase (Context *context)
Protected Member Functions inherited from Urho3D::ArchiveBase
	ArchiveBase (Context *context)
void	SetDelayedException (std::exception_ptr ptr)
void	FlushDelayedException ()
void	CheckIfNotEOF (ea::string_view elementName) const
void	CheckBlockOrElementName (ea::string_view elementName) const
void	CloseArchive ()
void	ReadBytesFromHexString (ea::string_view elementName, const ea::string &string, void *bytes, unsigned size)
Protected Member Functions inherited from Urho3D::MovableNonCopyable
	MovableNonCopyable (MovableNonCopyable &&other)=default
MovableNonCopyable &	operator= (MovableNonCopyable &&other)=default
	MovableNonCopyable (const MovableNonCopyable &other)=delete
MovableNonCopyable &	operator= (const MovableNonCopyable &other)=delete
Protected Attributes inherited from Urho3D::ArchiveBaseT< BinaryOutputArchiveBlock, IsInputBool, false >
ea::vector< Block >	stack_
Static Protected Attributes inherited from Urho3D::ArchiveBase
static constexpr const char *	rootBlockName = "Root"
static constexpr const char *	versionElementName = "Version"
Private Member Functions inherited from Urho3D::VectorBuffer
	VectorBuffer ()
	Construct an empty buffer.
	VectorBuffer (const ByteVector &data)
	Construct from another buffer.
	VectorBuffer (const void *data, unsigned size)
	Construct from a memory area.
	VectorBuffer (Deserializer &source, unsigned size)
	Construct from a stream.
const ea::string &	GetName () const override
	Returns name of this object.
unsigned	Read (void *dest, unsigned size) override
	Read bytes from the buffer. Return number of bytes actually read.
unsigned	Seek (unsigned position) override
	Set position from the beginning of the buffer. Return actual new position.
unsigned	Write (const void *data, unsigned size) override
	Write bytes to the buffer. Return number of bytes actually written.
void	SetData (const ByteVector &data)
	Set data from another buffer.
void	SetData (const void *data, unsigned size)
	Set data from a memory area.
void	SetData (Deserializer &source, unsigned size)
	Set data from a stream.
void	Clear ()
	Reset to zero size.
void	Resize (unsigned size)
	Set size.
const unsigned char *	GetData () const
	Return data.
unsigned char *	GetModifiableData ()
	Return non-const data.
const ByteVector &	GetBuffer () const
	Return the buffer.
ByteVector &	GetBuffer ()
	Return the buffer.
Private Member Functions inherited from Urho3D::AbstractFile
	AbstractFile ()
	Construct.
	AbstractFile (unsigned int size)
	Construct.
	~AbstractFile () override=default
	Destruct.
virtual void	SetName (const ea::string &name)
virtual bool	IsOpen () const
virtual const ea::string &	GetAbsoluteName () const
virtual void	Close ()
	Close the file.
Private Member Functions inherited from Urho3D::Deserializer
	Deserializer ()
	Construct with zero size.
	Deserializer (unsigned size)
	Construct with defined size.
virtual	~Deserializer ()
	Destruct.
virtual unsigned	GetChecksum ()
virtual bool	IsEof () const
unsigned	SeekRelative (int delta)
	Set position relative to current position. Return actual new position.
unsigned	GetPosition () const
unsigned	Tell () const
	Return current position.
unsigned	GetSize () const
long long	ReadInt64 ()
	Read a 64-bit integer.
int	ReadInt ()
	Read a 32-bit integer.
short	ReadShort ()
	Read a 16-bit integer.
signed char	ReadByte ()
	Read an 8-bit integer.
unsigned long long	ReadUInt64 ()
	Read a 64-bit unsigned integer.
unsigned	ReadUInt ()
	Read a 32-bit unsigned integer.
unsigned short	ReadUShort ()
	Read a 16-bit unsigned integer.
unsigned char	ReadUByte ()
	Read an 8-bit unsigned integer.
bool	ReadBool ()
	Read a bool.
float	ReadFloat ()
	Read a float.
double	ReadDouble ()
	Read a double.
IntRect	ReadIntRect ()
	Read an IntRect.
IntVector2	ReadIntVector2 ()
	Read an IntVector2.
IntVector3	ReadIntVector3 ()
	Read an IntVector3.
Rect	ReadRect ()
	Read a Rect.
Vector2	ReadVector2 ()
	Read a Vector2.
Vector3	ReadVector3 ()
	Read a Vector3.
Vector3	ReadPackedVector3 (float maxAbsCoord)
	Read a Vector3 packed into 3 x 16 bits with the specified maximum absolute range.
Vector4	ReadVector4 ()
	Read a Vector4.
Quaternion	ReadQuaternion ()
	Read a quaternion.
Quaternion	ReadPackedQuaternion ()
	Read a quaternion with each component packed in 16 bits.
Matrix3	ReadMatrix3 ()
	Read a Matrix3.
Matrix3x4	ReadMatrix3x4 ()
	Read a Matrix3x4.
Matrix4	ReadMatrix4 ()
	Read a Matrix4.
Color	ReadColor ()
	Read a color.
BoundingBox	ReadBoundingBox ()
	Read a bounding box.
ea::string	ReadString ()
	Read a null-terminated string.
ea::string	ReadFileID ()
	Read a four-letter file ID.
StringHash	ReadStringHash ()
	Read a 32-bit StringHash.
ByteVector	ReadBuffer ()
	Read a buffer with size encoded as VLE.
void	ReadBuffer (ByteVector &byteVector)
	Read a buffer with size encoded as VLE (inplace).
ResourceRef	ReadResourceRef ()
	Read a resource reference.
ResourceRefList	ReadResourceRefList ()
	Read a resource reference list.
Variant	ReadVariant ()
	Read a variant.
Variant	ReadVariant (VariantType type, Context *context=nullptr)
	Read a variant whose type is already known. Context is required for SharedPtr<Serializable>.
VariantVector	ReadVariantVector ()
	Read a variant vector.
StringVector	ReadStringVector ()
	Read a string vector.
VariantMap	ReadVariantMap ()
	Read a variant map.
StringVariantMap	ReadStringVariantMap ()
	Read a string variant map.
unsigned	ReadVLE ()
	Read a variable-length encoded unsigned integer.
ea::string	ReadLine ()
	Read a text line.
Private Member Functions inherited from Urho3D::Serializer
virtual	~Serializer ()
	Destruct.
bool	WriteInt64 (long long value)
	Write a 64-bit integer.
bool	WriteInt (int value)
	Write a 32-bit integer.
bool	WriteShort (short value)
	Write a 16-bit integer.
bool	WriteByte (signed char value)
	Write an 8-bit integer.
bool	WriteUInt64 (unsigned long long value)
	Write a 64-bit unsigned integer.
bool	WriteUInt (unsigned value)
	Write a 32-bit unsigned integer.
bool	WriteUShort (unsigned short value)
	Write a 16-bit unsigned integer.
bool	WriteUByte (unsigned char value)
	Write an 8-bit unsigned integer.
bool	WriteBool (bool value)
	Write a bool.
bool	WriteFloat (float value)
	Write a float.
bool	WriteDouble (double value)
	Write a double.
bool	WriteIntRect (const IntRect &value)
	Write an IntRect.
bool	WriteIntVector2 (const IntVector2 &value)
	Write an IntVector2.
bool	WriteIntVector3 (const IntVector3 &value)
	Write an IntVector3.
bool	WriteRect (const Rect &value)
	Write a Rect.
bool	WriteVector2 (const Vector2 &value)
	Write a Vector2.
bool	WriteVector3 (const Vector3 &value)
	Write a Vector3.
bool	WritePackedVector3 (const Vector3 &value, float maxAbsCoord)
	Write a Vector3 packed into 3 x 16 bits with the specified maximum absolute range.
bool	WriteVector4 (const Vector4 &value)
	Write a Vector4.
bool	WriteQuaternion (const Quaternion &value)
	Write a quaternion.
bool	WritePackedQuaternion (const Quaternion &value)
	Write a quaternion with each component packed in 16 bits.
bool	WriteMatrix3 (const Matrix3 &value)
	Write a Matrix3.
bool	WriteMatrix3x4 (const Matrix3x4 &value)
	Write a Matrix3x4.
bool	WriteMatrix4 (const Matrix4 &value)
	Write a Matrix4.
bool	WriteColor (const Color &value)
	Write a color.
bool	WriteBoundingBox (const BoundingBox &value)
	Write a bounding box.
bool	WriteString (ea::string_view value)
	Write a null-terminated string.
bool	WriteString (std::string_view value)
bool	WriteString (const char *value)
bool	WriteFileID (const ea::string &value)
	Write a four-letter file ID. If the string is not long enough, spaces will be appended.
bool	WriteStringHash (const StringHash &value)
	Write a 32-bit StringHash.
bool	WriteBuffer (const ea::vector< unsigned char > &value)
	Write a buffer, with size encoded as VLE.
bool	WriteResourceRef (const ResourceRef &value)
	Write a resource reference.
bool	WriteResourceRefList (const ResourceRefList &value)
	Write a resource reference list.
bool	WriteVariant (const Variant &value)
	Write a variant.
bool	WriteVariantData (const Variant &value)
	Write a variant without the type information.
bool	WriteVariantVector (const VariantVector &value)
	Write a variant vector.
bool	WriteStringVector (const StringVector &value)
	Write a variant vector.
bool	WriteVariantMap (const VariantMap &value)
	Write a variant map.
bool	WriteStringVariantMap (const StringVariantMap &value)
	Write a string variant map.
bool	WriteVLE (unsigned value)
	Write a variable-length encoded unsigned integer.
bool	WriteLine (const ea::string &value)
	Write a text line. Char codes 13 & 10 will be automatically appended.
Private Attributes inherited from Urho3D::AbstractFile
ea::string	name_
	File name.
Private Attributes inherited from Urho3D::Deserializer
unsigned	position_
	Stream position.
unsigned	size_
	Stream size.

Detailed Description

Base64 output archive.

---

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

• Urho3D/IO/Base64Archive.h
• Urho3D/IO/Base64Archive.cpp