mirror of
https://github.com/simdjson/simdjson
synced 2026-06-08 17:27:07 +00:00
lemire
178 lines
19 KiB
HTML
178 lines
19 KiB
HTML
<!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" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>simdjson: include/simdjson/padded_string_view.h Source File</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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.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" />
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
|
|
<link href="doxygen-awesome-sidebar-only-darkmode-toggle.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 id="projectrow">
|
|
<td id="projectlogo"><img alt="Logo" src="logotiny.png"/></td>
|
|
<td id="projectalign">
|
|
<div id="projectname">simdjson<span id="projectnumber"> 4.6.4</span>
|
|
</div>
|
|
<div id="projectbrief">Ridiculously Fast JSON</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function() { init_codefold(0); });
|
|
/* @license-end */
|
|
</script>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('padded__string__view_8h_source.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">padded_string_view.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef SIMDJSON_PADDED_STRING_VIEW_H</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define SIMDJSON_PADDED_STRING_VIEW_H</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include "simdjson/portability.h"</span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include "simdjson/base.h"</span> <span class="comment">// for SIMDJSON_PADDING</span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include "simdjson/error.h"</span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include <cstring></span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include <memory></span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include <ostream></span></div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacesimdjson.html">simdjson</a> {</div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
|
|
<div class="foldopen" id="foldopen00018" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="classsimdjson_1_1padded__string__view.html"> 18</a></span><span class="keyword">class </span><a class="code hl_class" href="classsimdjson_1_1padded__string__view.html">padded_string_view</a> : <span class="keyword">public</span> std::string_view {</div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="keyword">private</span>:</div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keywordtype">size_t</span> _capacity{0};</div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="keyword">public</span>:</div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="classsimdjson_1_1padded__string__view.html#aa338ad56304bc79e6ca1fab64af41de0"> 24</a></span> <span class="keyword">inline</span> <a class="code hl_function" href="classsimdjson_1_1padded__string__view.html#aa338ad56304bc79e6ca1fab64af41de0">padded_string_view</a>() noexcept = default;</div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> explicit inline <a class="code hl_class" href="classsimdjson_1_1padded__string__view.html">padded_string_view</a>(const <span class="keywordtype">char</span>* s, <span class="keywordtype">size_t</span> len, <span class="keywordtype">size_t</span> <a class="code hl_function" href="classsimdjson_1_1padded__string__view.html#a9d98e1984b893116d8bb7123d84d75b8">capacity</a>) noexcept;</div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> explicit inline <a class="code hl_class" href="classsimdjson_1_1padded__string__view.html">padded_string_view</a>(const uint8_t* s, <span class="keywordtype">size_t</span> len, <span class="keywordtype">size_t</span> <a class="code hl_function" href="classsimdjson_1_1padded__string__view.html#a9d98e1984b893116d8bb7123d84d75b8">capacity</a>) noexcept;</div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="preprocessor">#ifdef __cpp_char8_t</span></div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">explicit</span> <span class="keyword">inline</span> <a class="code hl_function" href="classsimdjson_1_1padded__string__view.html#aa338ad56304bc79e6ca1fab64af41de0">padded_string_view</a>(<span class="keyword">const</span> <span class="keywordtype">char8_t</span>* s, <span class="keywordtype">size_t</span> len, <span class="keywordtype">size_t</span> <a class="code hl_function" href="classsimdjson_1_1padded__string__view.html#a9d98e1984b893116d8bb7123d84d75b8">capacity</a>) <span class="keyword">noexcept</span>;</div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">explicit</span> <span class="keyword">inline</span> <a class="code hl_function" href="classsimdjson_1_1padded__string__view.html#aa338ad56304bc79e6ca1fab64af41de0">padded_string_view</a>(<span class="keyword">const</span> std::string &s) <span class="keyword">noexcept</span>;</div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
|
|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keyword">explicit</span> <span class="keyword">inline</span> <a class="code hl_function" href="classsimdjson_1_1padded__string__view.html#aa338ad56304bc79e6ca1fab64af41de0">padded_string_view</a>(std::string_view s, <span class="keywordtype">size_t</span> <a class="code hl_function" href="classsimdjson_1_1padded__string__view.html#a9d98e1984b893116d8bb7123d84d75b8">capacity</a>) <span class="keyword">noexcept</span>;</div>
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="keyword">inline</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classsimdjson_1_1padded__string__view.html#a9d98e1984b893116d8bb7123d84d75b8">capacity</a>() const noexcept;</div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> inline <span class="keywordtype">bool</span> <a class="code hl_function" href="classsimdjson_1_1padded__string__view.html#ae4aff182e0ed84ed5056c2d634ff134a">has_sufficient_padding</a>() const noexcept;</div>
|
|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> inline <span class="keywordtype">bool</span> <a class="code hl_function" href="classsimdjson_1_1padded__string__view.html#a572beea549bf5a58d62ffe4e768c1e82">remove_utf8_bom</a>() noexcept;</div>
|
|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> inline <span class="keywordtype">size_t</span> <a class="code hl_function" href="classsimdjson_1_1padded__string__view.html#a934e7272d22d6024383eafe07b06773c">padding</a>() const noexcept;</div>
|
|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> </div>
|
|
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span>}; <span class="comment">// padded_string_view</span></div>
|
|
</div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> </div>
|
|
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="preprocessor">#if SIMDJSON_EXCEPTIONS</span></div>
|
|
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="keyword">inline</span> std::ostream& operator<<(std::ostream& out, <a class="code hl_struct" href="structsimdjson_1_1simdjson__result.html">simdjson_result<padded_string_view></a> &s) <span class="keyword">noexcept</span>(<span class="keyword">false</span>);</div>
|
|
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> </div>
|
|
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span><span class="keyword">inline</span> <a class="code hl_class" href="classsimdjson_1_1padded__string__view.html">padded_string_view</a> <a class="code hl_function" href="namespacesimdjson.html#ac4131fd8cef9c8046d0bc9aee8d44d16">pad</a>(std::string& s) <span class="keyword">noexcept</span>;</div>
|
|
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> </div>
|
|
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span><span class="keyword">inline</span> <a class="code hl_class" href="classsimdjson_1_1padded__string__view.html">padded_string_view</a> <a class="code hl_function" href="namespacesimdjson.html#a687e6510cd2f94c7dc8a31a6db83d278">pad_with_reserve</a>(std::string& s) <span class="keyword">noexcept</span>;</div>
|
|
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span>} <span class="comment">// namespace simdjson</span></div>
|
|
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> </div>
|
|
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span><span class="preprocessor">#endif </span><span class="comment">// SIMDJSON_PADDED_STRING_VIEW_H</span></div>
|
|
<div class="ttc" id="aclasssimdjson_1_1padded__string__view_html"><div class="ttname"><a href="classsimdjson_1_1padded__string__view.html">simdjson::padded_string_view</a></div><div class="ttdoc">User-provided string that promises it has extra padded bytes at the end for use with parser::parse().</div><div class="ttdef"><b>Definition</b> <a href="padded__string__view_8h_source.html#l00018">padded_string_view.h:18</a></div></div>
|
|
<div class="ttc" id="aclasssimdjson_1_1padded__string__view_html_a572beea549bf5a58d62ffe4e768c1e82"><div class="ttname"><a href="classsimdjson_1_1padded__string__view.html#a572beea549bf5a58d62ffe4e768c1e82">simdjson::padded_string_view::remove_utf8_bom</a></div><div class="ttdeci">bool remove_utf8_bom() noexcept</div><div class="ttdoc">Remove the UTF-8 Byte Order Mark (BOM) if it exists.</div><div class="ttdef"><b>Definition</b> <a href="padded__string__view-inl_8h_source.html#l00058">padded_string_view-inl.h:58</a></div></div>
|
|
<div class="ttc" id="aclasssimdjson_1_1padded__string__view_html_a934e7272d22d6024383eafe07b06773c"><div class="ttname"><a href="classsimdjson_1_1padded__string__view.html#a934e7272d22d6024383eafe07b06773c">simdjson::padded_string_view::padding</a></div><div class="ttdeci">size_t padding() const noexcept</div><div class="ttdoc">The amount of padding on the string (capacity() - length())</div><div class="ttdef"><b>Definition</b> <a href="padded__string__view-inl_8h_source.html#l00056">padded_string_view-inl.h:56</a></div></div>
|
|
<div class="ttc" id="aclasssimdjson_1_1padded__string__view_html_a9d98e1984b893116d8bb7123d84d75b8"><div class="ttname"><a href="classsimdjson_1_1padded__string__view.html#a9d98e1984b893116d8bb7123d84d75b8">simdjson::padded_string_view::capacity</a></div><div class="ttdeci">size_t capacity() const noexcept</div><div class="ttdoc">The number of allocated bytes.</div><div class="ttdef"><b>Definition</b> <a href="padded__string__view-inl_8h_source.html#l00054">padded_string_view-inl.h:54</a></div></div>
|
|
<div class="ttc" id="aclasssimdjson_1_1padded__string__view_html_aa338ad56304bc79e6ca1fab64af41de0"><div class="ttname"><a href="classsimdjson_1_1padded__string__view.html#aa338ad56304bc79e6ca1fab64af41de0">simdjson::padded_string_view::padded_string_view</a></div><div class="ttdeci">padded_string_view() noexcept=default</div><div class="ttdoc">Create an empty padded_string_view.</div></div>
|
|
<div class="ttc" id="aclasssimdjson_1_1padded__string__view_html_ae4aff182e0ed84ed5056c2d634ff134a"><div class="ttname"><a href="classsimdjson_1_1padded__string__view.html#ae4aff182e0ed84ed5056c2d634ff134a">simdjson::padded_string_view::has_sufficient_padding</a></div><div class="ttdeci">bool has_sufficient_padding() const noexcept</div><div class="ttdoc">check that the view has sufficient padding</div><div class="ttdef"><b>Definition</b> <a href="padded__string__view-inl_8h_source.html#l00038">padded_string_view-inl.h:38</a></div></div>
|
|
<div class="ttc" id="anamespacesimdjson_html"><div class="ttname"><a href="namespacesimdjson.html">simdjson</a></div><div class="ttdoc">The top level simdjson namespace, containing everything the library provides.</div><div class="ttdef"><b>Definition</b> <a href="arm64_2base_8h_source.html#l00008">base.h:8</a></div></div>
|
|
<div class="ttc" id="anamespacesimdjson_html_a687e6510cd2f94c7dc8a31a6db83d278"><div class="ttname"><a href="namespacesimdjson.html#a687e6510cd2f94c7dc8a31a6db83d278">simdjson::pad_with_reserve</a></div><div class="ttdeci">padded_string_view pad_with_reserve(std::string &s) noexcept</div><div class="ttdoc">Create a padded_string_view from a string.</div><div class="ttdef"><b>Definition</b> <a href="padded__string__view-inl_8h_source.html#l00091">padded_string_view-inl.h:91</a></div></div>
|
|
<div class="ttc" id="anamespacesimdjson_html_ac4131fd8cef9c8046d0bc9aee8d44d16"><div class="ttname"><a href="namespacesimdjson.html#ac4131fd8cef9c8046d0bc9aee8d44d16">simdjson::pad</a></div><div class="ttdeci">padded_string_view pad(std::string &s) noexcept</div><div class="ttdoc">Create a padded_string_view from a string.</div><div class="ttdef"><b>Definition</b> <a href="padded__string__view-inl_8h_source.html#l00072">padded_string_view-inl.h:72</a></div></div>
|
|
<div class="ttc" id="astructsimdjson_1_1simdjson__result_html"><div class="ttname"><a href="structsimdjson_1_1simdjson__result.html">simdjson::simdjson_result</a></div><div class="ttdoc">The result of a simdjson operation that could fail.</div><div class="ttdef"><b>Definition</b> <a href="error_8h_source.html#l00280">error.h:280</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_49a0b2767ded4a45005c5d6720a18cd1.html">simdjson</a></li><li class="navelem"><b>padded_string_view.h</b></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|