entt::basic_hashed_string< Char > Class Template Reference

Zero overhead unique identifier. More...

#include <hashed_string.hpp>

Public Types
using	value_type = Char
	Character type.
using	hash_type = ENTT_ID_TYPE
	Unsigned integer type.

Public Member Functions
constexpr	basic_hashed_string () ENTT_NOEXCEPT
	Constructs an empty hashed string.
template<std::size_t N>
constexpr	basic_hashed_string (const value_type(&curr)[N]) ENTT_NOEXCEPT
	Constructs a hashed string from an array of const characters. More...
constexpr	basic_hashed_string (const_wrapper wrapper) ENTT_NOEXCEPT
	Explicit constructor on purpose to avoid constructing a hashed string directly from a const value_type *. More...
constexpr const value_type *	data () const ENTT_NOEXCEPT
	Returns the human-readable representation of a hashed string. More...
constexpr hash_type	value () const ENTT_NOEXCEPT
	Returns the numeric representation of a hashed string. More...
constexpr	operator const value_type * () const ENTT_NOEXCEPT
	Returns the human-readable representation of a hashed string. More...
constexpr	operator hash_type () const ENTT_NOEXCEPT
	Returns the numeric representation of a hashed string. More...
constexpr bool	operator== (const basic_hashed_string &other) const ENTT_NOEXCEPT
	Compares two hashed strings. More...

Static Public Member Functions
template<std::size_t N>
static constexpr hash_type	to_value (const value_type(&str)[N]) ENTT_NOEXCEPT
	Returns directly the numeric representation of a string. More...
static hash_type	to_value (const_wrapper wrapper) ENTT_NOEXCEPT
	Returns directly the numeric representation of a string. More...
static hash_type	to_value (const value_type *str, std::size_t size) ENTT_NOEXCEPT
	Returns directly the numeric representation of a string view. More...

Detailed Description

template<typename Char>
class entt::basic_hashed_string< Char >

Zero overhead unique identifier.

TURN_OFF_DOXYGEN A hashed string is a compile-time tool that allows users to use human-readable identifers in the codebase while using their numeric counterparts at runtime.
Because of that, a hashed string can also be used in constant expressions if required.

Template Parameters

Char	Character type.

Definition at line 60 of file hashed_string.hpp.

Constructor & Destructor Documentation

basic_hashed_string() [1/2]

template<typename Char>

template<std::size_t N>

constexpr entt::basic_hashed_string< Char >::basic_hashed_string ( const value_type(&)  curr[N] )

inlineconstexpr

Constructs a hashed string from an array of const characters.

Forcing template resolution avoids implicit conversions. An human-readable identifier can be anything but a plain, old bunch of characters.
Example of use:

basic_hashed_string<char> hs{"my.png"};

Template Parameters

N	Number of characters of the identifier.

Parameters

curr	Human-readable identifer.

Definition at line 141 of file hashed_string.hpp.

basic_hashed_string() [2/2]

template<typename Char>

constexpr entt::basic_hashed_string< Char >::basic_hashed_string ( const_wrapper  wrapper )

inlineexplicitconstexpr

Explicit constructor on purpose to avoid constructing a hashed string directly from a const value_type *.

Parameters

wrapper

Helps achieving the purpose by relying on overloading.

Definition at line 150 of file hashed_string.hpp.

Member Function Documentation

data()

template<typename Char>

constexpr const value_type* entt::basic_hashed_string< Char >::data ( ) const

inlineconstexpr

Returns the human-readable representation of a hashed string.

Returns

The string used to initialize the instance.

Definition at line 158 of file hashed_string.hpp.

operator const value_type *()

template<typename Char>

constexpr entt::basic_hashed_string< Char >::operator const value_type * ( ) const

inlineconstexpr

Returns the human-readable representation of a hashed string.

Returns

The string used to initialize the instance.

Definition at line 174 of file hashed_string.hpp.

operator hash_type()

template<typename Char>

constexpr entt::basic_hashed_string< Char >::operator hash_type ( ) const

inlineconstexpr

Returns the numeric representation of a hashed string.

Returns

The numeric representation of the instance.

Definition at line 177 of file hashed_string.hpp.

operator==()

template<typename Char>

constexpr bool entt::basic_hashed_string< Char >::operator== ( const basic_hashed_string< Char > &  other ) const

inlineconstexpr

Compares two hashed strings.

Parameters

other

Hashed string with which to compare.

Returns

True if the two hashed strings are identical, false otherwise.

Definition at line 184 of file hashed_string.hpp.

to_value() [1/3]

template<typename Char>

static hash_type entt::basic_hashed_string< Char >::to_value ( const value_type *  str, std::size_t  size  )

inlinestatic

Returns directly the numeric representation of a string view.

Parameters

str	Human-readable identifer.
size	Length of the string to hash.

Returns

The numeric representation of the string.

Definition at line 115 of file hashed_string.hpp.

to_value() [2/3]

template<typename Char>

template<std::size_t N>

static constexpr hash_type entt::basic_hashed_string< Char >::to_value ( const value_type(&)  str[N] )

inlinestaticconstexpr

Returns directly the numeric representation of a string.

Forcing template resolution avoids implicit conversions. An human-readable identifier can be anything but a plain, old bunch of characters.
Example of use:

const auto value = basic_hashed_string<char>::to_value("my.png");

Template Parameters

N	Number of characters of the identifier.

Parameters

str	Human-readable identifer.

Returns

The numeric representation of the string.

Definition at line 96 of file hashed_string.hpp.

to_value() [3/3]

template<typename Char>

static hash_type entt::basic_hashed_string< Char >::to_value ( const_wrapper  wrapper )

inlinestatic

Returns directly the numeric representation of a string.

Parameters

wrapper

Helps achieving the purpose by relying on overloading.

Returns

The numeric representation of the string.

Definition at line 105 of file hashed_string.hpp.

value()

template<typename Char>

constexpr hash_type entt::basic_hashed_string< Char >::value ( ) const

inlineconstexpr

Returns the numeric representation of a hashed string.

Returns

The numeric representation of the instance.

Definition at line 166 of file hashed_string.hpp.

---

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

• src/entt/core/hashed_string.hpp