Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
30a3f4ffca455082f66a83e812a7f378d76056d4
entt/classentt_1_1basic__hashed__string.html
Michele Caini 30a3f4ffca API reference v3.3.2
2020-03-07 18:44:24 +01:00

559 lines
33 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: entt::basic_hashed_string&lt; Char &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">EnTT
&#160;<span id="projectnumber">3.3.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceentt.html">entt</a></li><li class="navelem"><a class="el" href="classentt_1_1basic__hashed__string.html">basic_hashed_string</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classentt_1_1basic__hashed__string-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">entt::basic_hashed_string&lt; Char &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Zero overhead unique identifier.
<a href="classentt_1_1basic__hashed__string.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ad4e8f181e92b9218747ac43fe24c4cbc"><td class="memItemLeft" align="right" valign="top"><a id="ad4e8f181e92b9218747ac43fe24c4cbc"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#ad4e8f181e92b9218747ac43fe24c4cbc">value_type</a> = Char</td></tr>
<tr class="memdesc:ad4e8f181e92b9218747ac43fe24c4cbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Character type. <br /></td></tr>
<tr class="separator:ad4e8f181e92b9218747ac43fe24c4cbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ee7dca5383cf4507949dc1261ca5efd"><td class="memItemLeft" align="right" valign="top"><a id="a7ee7dca5383cf4507949dc1261ca5efd"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#a7ee7dca5383cf4507949dc1261ca5efd">hash_type</a> = ENTT_ID_TYPE</td></tr>
<tr class="memdesc:a7ee7dca5383cf4507949dc1261ca5efd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unsigned integer type. <br /></td></tr>
<tr class="separator:a7ee7dca5383cf4507949dc1261ca5efd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2c75763872c028b062701523e0314f29"><td class="memItemLeft" align="right" valign="top"><a id="a2c75763872c028b062701523e0314f29"></a>
constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#a2c75763872c028b062701523e0314f29">basic_hashed_string</a> () ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a2c75763872c028b062701523e0314f29"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an empty hashed string. <br /></td></tr>
<tr class="separator:a2c75763872c028b062701523e0314f29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac422f04d11c1e5573f04809c1e1c106"><td class="memTemplParams" colspan="2">template&lt;std::size_t N&gt; </td></tr>
<tr class="memitem:aac422f04d11c1e5573f04809c1e1c106"><td class="memTemplItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#aac422f04d11c1e5573f04809c1e1c106">basic_hashed_string</a> (const <a class="el" href="classentt_1_1basic__hashed__string.html#ad4e8f181e92b9218747ac43fe24c4cbc">value_type</a>(&amp;curr)[N]) ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:aac422f04d11c1e5573f04809c1e1c106"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a hashed string from an array of const characters. <a href="classentt_1_1basic__hashed__string.html#aac422f04d11c1e5573f04809c1e1c106">More...</a><br /></td></tr>
<tr class="separator:aac422f04d11c1e5573f04809c1e1c106"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ab5e09f3e552436872bcaaf9ca2c1ac"><td class="memItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#a7ab5e09f3e552436872bcaaf9ca2c1ac">basic_hashed_string</a> (const_wrapper wrapper) ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a7ab5e09f3e552436872bcaaf9ca2c1ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Explicit constructor on purpose to avoid constructing a hashed string directly from a <code>const value_type *</code>. <a href="classentt_1_1basic__hashed__string.html#a7ab5e09f3e552436872bcaaf9ca2c1ac">More...</a><br /></td></tr>
<tr class="separator:a7ab5e09f3e552436872bcaaf9ca2c1ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ef3ad96865551846e584780146d3d24"><td class="memItemLeft" align="right" valign="top">constexpr const <a class="el" href="classentt_1_1basic__hashed__string.html#ad4e8f181e92b9218747ac43fe24c4cbc">value_type</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#a7ef3ad96865551846e584780146d3d24">data</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a7ef3ad96865551846e584780146d3d24"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the human-readable representation of a hashed string. <a href="classentt_1_1basic__hashed__string.html#a7ef3ad96865551846e584780146d3d24">More...</a><br /></td></tr>
<tr class="separator:a7ef3ad96865551846e584780146d3d24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb3a92282e81fb50af66953f39671f3c"><td class="memItemLeft" align="right" valign="top">constexpr <a class="el" href="classentt_1_1basic__hashed__string.html#a7ee7dca5383cf4507949dc1261ca5efd">hash_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#afb3a92282e81fb50af66953f39671f3c">value</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:afb3a92282e81fb50af66953f39671f3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the numeric representation of a hashed string. <a href="classentt_1_1basic__hashed__string.html#afb3a92282e81fb50af66953f39671f3c">More...</a><br /></td></tr>
<tr class="separator:afb3a92282e81fb50af66953f39671f3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0cc0b27f0dd52a07e25f5014ba426fc"><td class="memItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#ad0cc0b27f0dd52a07e25f5014ba426fc">operator const value_type *</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:ad0cc0b27f0dd52a07e25f5014ba426fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the human-readable representation of a hashed string. <a href="classentt_1_1basic__hashed__string.html#ad0cc0b27f0dd52a07e25f5014ba426fc">More...</a><br /></td></tr>
<tr class="separator:ad0cc0b27f0dd52a07e25f5014ba426fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2009a1ac648d8bdaeac642a6476f2bd"><td class="memItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#aa2009a1ac648d8bdaeac642a6476f2bd">operator hash_type</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:aa2009a1ac648d8bdaeac642a6476f2bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the numeric representation of a hashed string. <a href="classentt_1_1basic__hashed__string.html#aa2009a1ac648d8bdaeac642a6476f2bd">More...</a><br /></td></tr>
<tr class="separator:aa2009a1ac648d8bdaeac642a6476f2bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51311d6903443296ce076536df2b46da"><td class="memItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#a51311d6903443296ce076536df2b46da">operator==</a> (const <a class="el" href="classentt_1_1basic__hashed__string.html">basic_hashed_string</a> &amp;other) const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a51311d6903443296ce076536df2b46da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares two hashed strings. <a href="classentt_1_1basic__hashed__string.html#a51311d6903443296ce076536df2b46da">More...</a><br /></td></tr>
<tr class="separator:a51311d6903443296ce076536df2b46da"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:abbd837edf6b152c7b46bfd619241264c"><td class="memTemplParams" colspan="2">template&lt;std::size_t N&gt; </td></tr>
<tr class="memitem:abbd837edf6b152c7b46bfd619241264c"><td class="memTemplItemLeft" align="right" valign="top">static constexpr <a class="el" href="classentt_1_1basic__hashed__string.html#a7ee7dca5383cf4507949dc1261ca5efd">hash_type</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#abbd837edf6b152c7b46bfd619241264c">value</a> (const <a class="el" href="classentt_1_1basic__hashed__string.html#ad4e8f181e92b9218747ac43fe24c4cbc">value_type</a>(&amp;str)[N]) ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:abbd837edf6b152c7b46bfd619241264c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns directly the numeric representation of a string. <a href="classentt_1_1basic__hashed__string.html#abbd837edf6b152c7b46bfd619241264c">More...</a><br /></td></tr>
<tr class="separator:abbd837edf6b152c7b46bfd619241264c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c29491d20b14d8815229604d3580d3e"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classentt_1_1basic__hashed__string.html#a7ee7dca5383cf4507949dc1261ca5efd">hash_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#a9c29491d20b14d8815229604d3580d3e">value</a> (const_wrapper wrapper) ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a9c29491d20b14d8815229604d3580d3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns directly the numeric representation of a string. <a href="classentt_1_1basic__hashed__string.html#a9c29491d20b14d8815229604d3580d3e">More...</a><br /></td></tr>
<tr class="separator:a9c29491d20b14d8815229604d3580d3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ccb9802c4f1077537df9b56e33e1f46"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classentt_1_1basic__hashed__string.html#a7ee7dca5383cf4507949dc1261ca5efd">hash_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__hashed__string.html#a7ccb9802c4f1077537df9b56e33e1f46">value</a> (const <a class="el" href="classentt_1_1basic__hashed__string.html#ad4e8f181e92b9218747ac43fe24c4cbc">value_type</a> *str, std::size_t size) ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a7ccb9802c4f1077537df9b56e33e1f46"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns directly the numeric representation of a string view. <a href="classentt_1_1basic__hashed__string.html#a7ccb9802c4f1077537df9b56e33e1f46">More...</a><br /></td></tr>
<tr class="separator:a7ccb9802c4f1077537df9b56e33e1f46"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename Char&gt;<br />
class entt::basic_hashed_string&lt; Char &gt;</h3>
<p>Zero overhead unique identifier. </p>
<p>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.<br />
Because of that, a hashed string can also be used in constant expressions if required.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Char</td><td>Character type. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00063">63</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aac422f04d11c1e5573f04809c1e1c106"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac422f04d11c1e5573f04809c1e1c106">&#9670;&nbsp;</a></span>basic_hashed_string() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Char&gt; </div>
<div class="memtemplate">
template&lt;std::size_t N&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="el" href="classentt_1_1basic__hashed__string.html">entt::basic_hashed_string</a>&lt; Char &gt;::<a class="el" href="classentt_1_1basic__hashed__string.html">basic_hashed_string</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classentt_1_1basic__hashed__string.html#ad4e8f181e92b9218747ac43fe24c4cbc">value_type</a>(&amp;)&#160;</td>
<td class="paramname"><em>curr</em>[N]</td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a hashed string from an array of const characters. </p>
<p>Forcing template resolution avoids implicit conversions. An human-readable identifier can be anything but a plain, old bunch of characters.<br />
Example of use: </p><div class="fragment"><div class="line">basic_hashed_string&lt;char&gt; hs{<span class="stringliteral">&quot;my.png&quot;</span>};</div>
</div><!-- fragment --><dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">N</td><td>Number of characters of the identifier. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">curr</td><td>Human-readable identifer. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00150">150</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
</div>
</div>
<a id="a7ab5e09f3e552436872bcaaf9ca2c1ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ab5e09f3e552436872bcaaf9ca2c1ac">&#9670;&nbsp;</a></span>basic_hashed_string() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Char&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="el" href="classentt_1_1basic__hashed__string.html">entt::basic_hashed_string</a>&lt; Char &gt;::<a class="el" href="classentt_1_1basic__hashed__string.html">basic_hashed_string</a> </td>
<td>(</td>
<td class="paramtype">const_wrapper&#160;</td>
<td class="paramname"><em>wrapper</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Explicit constructor on purpose to avoid constructing a hashed string directly from a <code>const value_type *</code>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">wrapper</td><td>Helps achieving the purpose by relying on overloading. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00159">159</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a7ef3ad96865551846e584780146d3d24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ef3ad96865551846e584780146d3d24">&#9670;&nbsp;</a></span>data()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Char&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr const <a class="el" href="classentt_1_1basic__hashed__string.html#ad4e8f181e92b9218747ac43fe24c4cbc">value_type</a>* <a class="el" href="classentt_1_1basic__hashed__string.html">entt::basic_hashed_string</a>&lt; Char &gt;::data </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the human-readable representation of a hashed string. </p>
<dl class="section return"><dt>Returns</dt><dd>The string used to initialize the instance. </dd></dl>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00167">167</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
</div>
</div>
<a id="ad0cc0b27f0dd52a07e25f5014ba426fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0cc0b27f0dd52a07e25f5014ba426fc">&#9670;&nbsp;</a></span>operator const value_type *()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Char&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="el" href="classentt_1_1basic__hashed__string.html">entt::basic_hashed_string</a>&lt; Char &gt;::operator const <a class="el" href="classentt_1_1basic__hashed__string.html#ad4e8f181e92b9218747ac43fe24c4cbc">value_type</a> * </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the human-readable representation of a hashed string. </p>
<dl class="section return"><dt>Returns</dt><dd>The string used to initialize the instance. </dd></dl>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00180">180</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
</div>
</div>
<a id="aa2009a1ac648d8bdaeac642a6476f2bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2009a1ac648d8bdaeac642a6476f2bd">&#9670;&nbsp;</a></span>operator hash_type()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Char&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="el" href="classentt_1_1basic__hashed__string.html">entt::basic_hashed_string</a>&lt; Char &gt;::operator <a class="el" href="classentt_1_1basic__hashed__string.html#a7ee7dca5383cf4507949dc1261ca5efd">hash_type</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the numeric representation of a hashed string. </p>
<dl class="section return"><dt>Returns</dt><dd>The numeric representation of the instance. </dd></dl>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00186">186</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
</div>
</div>
<a id="a51311d6903443296ce076536df2b46da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51311d6903443296ce076536df2b46da">&#9670;&nbsp;</a></span>operator==()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Char&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr bool <a class="el" href="classentt_1_1basic__hashed__string.html">entt::basic_hashed_string</a>&lt; Char &gt;::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classentt_1_1basic__hashed__string.html">basic_hashed_string</a>&lt; Char &gt; &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Compares two hashed strings. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>Hashed string with which to compare. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the two hashed strings are identical, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00193">193</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
</div>
</div>
<a id="afb3a92282e81fb50af66953f39671f3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb3a92282e81fb50af66953f39671f3c">&#9670;&nbsp;</a></span>value() <span class="overload">[1/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Char&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="el" href="classentt_1_1basic__hashed__string.html#a7ee7dca5383cf4507949dc1261ca5efd">hash_type</a> <a class="el" href="classentt_1_1basic__hashed__string.html">entt::basic_hashed_string</a>&lt; Char &gt;::value </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the numeric representation of a hashed string. </p>
<dl class="section return"><dt>Returns</dt><dd>The numeric representation of the instance. </dd></dl>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00175">175</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
</div>
</div>
<a id="a7ccb9802c4f1077537df9b56e33e1f46"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ccb9802c4f1077537df9b56e33e1f46">&#9670;&nbsp;</a></span>value() <span class="overload">[2/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Char&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classentt_1_1basic__hashed__string.html#a7ee7dca5383cf4507949dc1261ca5efd">hash_type</a> <a class="el" href="classentt_1_1basic__hashed__string.html">entt::basic_hashed_string</a>&lt; Char &gt;::value </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classentt_1_1basic__hashed__string.html#ad4e8f181e92b9218747ac43fe24c4cbc">value_type</a> *&#160;</td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::size_t&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns directly the numeric representation of a string view. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>Human-readable identifer. </td></tr>
<tr><td class="paramname">size</td><td>Length of the string to hash. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The numeric representation of the string. </dd></dl>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00124">124</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
</div>
</div>
<a id="abbd837edf6b152c7b46bfd619241264c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abbd837edf6b152c7b46bfd619241264c">&#9670;&nbsp;</a></span>value() <span class="overload">[3/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Char&gt; </div>
<div class="memtemplate">
template&lt;std::size_t N&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static constexpr <a class="el" href="classentt_1_1basic__hashed__string.html#a7ee7dca5383cf4507949dc1261ca5efd">hash_type</a> <a class="el" href="classentt_1_1basic__hashed__string.html">entt::basic_hashed_string</a>&lt; Char &gt;::value </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classentt_1_1basic__hashed__string.html#ad4e8f181e92b9218747ac43fe24c4cbc">value_type</a>(&amp;)&#160;</td>
<td class="paramname"><em>str</em>[N]</td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns directly the numeric representation of a string. </p>
<p>Forcing template resolution avoids implicit conversions. An human-readable identifier can be anything but a plain, old bunch of characters.<br />
Example of use: </p><div class="fragment"><div class="line"><span class="keyword">const</span> <span class="keyword">auto</span> <a class="code" href="classentt_1_1basic__hashed__string.html#afb3a92282e81fb50af66953f39671f3c">value</a> = basic_hashed_string&lt;char&gt;::to_value(<span class="stringliteral">&quot;my.png&quot;</span>);</div>
</div><!-- fragment --><dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">N</td><td>Number of characters of the identifier. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>Human-readable identifer. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The numeric representation of the string. </dd></dl>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00105">105</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
</div>
</div>
<a id="a9c29491d20b14d8815229604d3580d3e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c29491d20b14d8815229604d3580d3e">&#9670;&nbsp;</a></span>value() <span class="overload">[4/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Char&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classentt_1_1basic__hashed__string.html#a7ee7dca5383cf4507949dc1261ca5efd">hash_type</a> <a class="el" href="classentt_1_1basic__hashed__string.html">entt::basic_hashed_string</a>&lt; Char &gt;::value </td>
<td>(</td>
<td class="paramtype">const_wrapper&#160;</td>
<td class="paramname"><em>wrapper</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns directly the numeric representation of a string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">wrapper</td><td>Helps achieving the purpose by relying on overloading. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The numeric representation of the string. </dd></dl>
<p class="definition">Definition at line <a class="el" href="hashed__string_8hpp_source.html#l00114">114</a> of file <a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/entt/core/<a class="el" href="hashed__string_8hpp_source.html">hashed_string.hpp</a></li>
</ul>
</div><!-- contents -->
<div class="ttc" id="aclassentt_1_1basic__hashed__string_html_afb3a92282e81fb50af66953f39671f3c"><div class="ttname"><a href="classentt_1_1basic__hashed__string.html#afb3a92282e81fb50af66953f39671f3c">entt::basic_hashed_string::value</a></div><div class="ttdeci">constexpr hash_type value() const ENTT_NOEXCEPT</div><div class="ttdoc">Returns the numeric representation of a hashed string.</div><div class="ttdef"><b>Definition:</b> <a href="hashed__string_8hpp_source.html#l00175">hashed_string.hpp:175</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.16
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink