WorldPackets::String< MaxBytesWithoutNullTerminator, Validators > Class Template Reference

#include "PacketUtilities.h"

Public Member Functions
bool	empty () const
char const *	c_str () const
	operator std::string_view () const
	operator std::string & ()
	operator std::string const & () const
std::string &&	Move ()

Private Types
using	ValidatorList = std::conditional_t<!Acore::has_type< Strings::RawBytes, std::tuple< Validators... > >::value, std::tuple< Strings::ByteSize< MaxBytesWithoutNullTerminator >, Strings::Utf8, Validators... >, std::tuple< Strings::ByteSize< MaxBytesWithoutNullTerminator >, Validators... > >

Private Member Functions
bool	Validate () const
template<std::size_t... indexes>
bool	ValidateNth (std::index_sequence< indexes... >) const

Private Attributes
std::string	_storage

Friends
ByteBuffer &	operator>> (ByteBuffer &data, String &value)

Detailed Description

template<std::size_t MaxBytesWithoutNullTerminator, typename... Validators>
class WorldPackets::String< MaxBytesWithoutNullTerminator, Validators >

Utility class for automated prevention of invalid strings in client packets

Member Typedef Documentation

ValidatorList

template<std::size_t MaxBytesWithoutNullTerminator, typename... Validators>

using WorldPackets::String< MaxBytesWithoutNullTerminator, Validators >::ValidatorList = std::conditional_t<!Acore::has_type<Strings::RawBytes, std::tuple<Validators...> >::value, std::tuple<Strings::ByteSize<MaxBytesWithoutNullTerminator>, Strings::Utf8, Validators...>, std::tuple<Strings::ByteSize<MaxBytesWithoutNullTerminator>, Validators...> >

private

Member Function Documentation

c_str()

template<std::size_t MaxBytesWithoutNullTerminator, typename... Validators>

char const * WorldPackets::String< MaxBytesWithoutNullTerminator, Validators >::c_str ( ) const

inline

{ return _storage.c_str(); }

References WorldPackets::String< MaxBytesWithoutNullTerminator, Validators >::_storage.

empty()

template<std::size_t MaxBytesWithoutNullTerminator, typename... Validators>

bool WorldPackets::String< MaxBytesWithoutNullTerminator, Validators >::empty ( ) const

inline

{ return _storage.empty(); }

References WorldPackets::String< MaxBytesWithoutNullTerminator, Validators >::_storage.

Referenced by WorldSession::HandleGuildBankUpdateTab().

Move()

template<std::size_t MaxBytesWithoutNullTerminator, typename... Validators>

std::string && WorldPackets::String< MaxBytesWithoutNullTerminator, Validators >::Move ( )

inline

{ return std::move(_storage); }

References WorldPackets::String< MaxBytesWithoutNullTerminator, Validators >::_storage.

operator std::string &()

template<std::size_t MaxBytesWithoutNullTerminator, typename... Validators>

WorldPackets::String< MaxBytesWithoutNullTerminator, Validators >::operator std::string & ( )

inline

{ return _storage; }

References WorldPackets::String< MaxBytesWithoutNullTerminator, Validators >::_storage.

operator std::string const &()

template<std::size_t MaxBytesWithoutNullTerminator, typename... Validators>

WorldPackets::String< MaxBytesWithoutNullTerminator, Validators >::operator std::string const & ( ) const

inline

{ return _storage; }

References WorldPackets::String< MaxBytesWithoutNullTerminator, Validators >::_storage.

operator std::string_view()

template<std::size_t MaxBytesWithoutNullTerminator, typename... Validators>

WorldPackets::String< MaxBytesWithoutNullTerminator, Validators >::operator std::string_view ( ) const

inline

{ return _storage; }

References WorldPackets::String< MaxBytesWithoutNullTerminator, Validators >::_storage.

Validate()

template<std::size_t MaxBytesWithoutNullTerminator, typename... Validators>

bool WorldPackets::String< MaxBytesWithoutNullTerminator, Validators >::Validate ( ) const

inlineprivate

        {
            return ValidateNth(std::make_index_sequence<std::tuple_size_v<ValidatorList>>{});
        }

References WorldPackets::String< MaxBytesWithoutNullTerminator, Validators >::ValidateNth().

ValidateNth()

template<std::size_t MaxBytesWithoutNullTerminator, typename... Validators>

template<std::size_t... indexes>

bool WorldPackets::String< MaxBytesWithoutNullTerminator, Validators >::ValidateNth ( std::index_sequence< indexes... >  ) const

inlineprivate

        {
            return (std::tuple_element_t<indexes, ValidatorList>::Validate(_storage) && ...);
        }

References WorldPackets::String< MaxBytesWithoutNullTerminator, Validators >::_storage.

Referenced by WorldPackets::String< MaxBytesWithoutNullTerminator, Validators >::Validate().

Friends And Related Function Documentation

operator>>

template<std::size_t MaxBytesWithoutNullTerminator, typename... Validators>

ByteBuffer & operator>> ( ByteBuffer &  data, String< MaxBytesWithoutNullTerminator, Validators > &  value  )

friend

        {
            value._storage = data.ReadCString(false);
            value.Validate();
            return data;
        }

Member Data Documentation

_storage

template<std::size_t MaxBytesWithoutNullTerminator, typename... Validators>

std::string WorldPackets::String< MaxBytesWithoutNullTerminator, Validators >::_storage

private

Referenced by WorldPackets::String< MaxBytesWithoutNullTerminator, Validators >::c_str(), WorldPackets::String< MaxBytesWithoutNullTerminator, Validators >::empty(), WorldPackets::String< MaxBytesWithoutNullTerminator, Validators >::Move(), WorldPackets::String< MaxBytesWithoutNullTerminator, Validators >::operator std::string &(), WorldPackets::String< MaxBytesWithoutNullTerminator, Validators >::operator std::string const &(), WorldPackets::String< MaxBytesWithoutNullTerminator, Validators >::operator std::string_view(), and WorldPackets::String< MaxBytesWithoutNullTerminator, Validators >::ValidateNth().