admin/simdjson-simdjson
1
0
Fork 0
mirror of https://github.com/simdjson/simdjson synced 2026-06-08 17:27:07 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
df2f3f4cd8d9acc193d367eb5a41ec0bc41fe81a
simdjson-simdjson/classsimdjson_1_1padded__string__view.html
T
lemire 1af8b800a4 deploy: 3620e9d151
2024-06-11 19:53:52 +00:00

327 lines
18 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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>simdjson: simdjson::padded_string_view Class 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="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 style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logotiny.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">simdjson
&#160;<span id="projectnumber">3.9.4</span>
</div>
<div id="projectbrief">Ridiculously Fast JSON</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.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: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>
</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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classsimdjson_1_1padded__string__view.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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classsimdjson_1_1padded__string__view-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">simdjson::padded_string_view Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>User-provided string that promises it has extra padded bytes at the end for use with parser::parse().
<a href="classsimdjson_1_1padded__string__view.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for simdjson::padded_string_view:</div>
<div class="dyncontent">
<div class="center">
<img src="classsimdjson_1_1padded__string__view.png" alt=""/>
</div></div>
<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:aa338ad56304bc79e6ca1fab64af41de0"><td class="memItemLeft" align="right" valign="top"><a id="aa338ad56304bc79e6ca1fab64af41de0"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsimdjson_1_1padded__string__view.html#aa338ad56304bc79e6ca1fab64af41de0">padded_string_view</a> () noexcept=default</td></tr>
<tr class="memdesc:aa338ad56304bc79e6ca1fab64af41de0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an empty <a class="el" href="classsimdjson_1_1padded__string__view.html" title="User-provided string that promises it has extra padded bytes at the end for use with parser::parse().">padded_string_view</a>. <br /></td></tr>
<tr class="separator:aa338ad56304bc79e6ca1fab64af41de0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47ac0063f7dd0ffd832c5e4439f2de30"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsimdjson_1_1padded__string__view.html#a47ac0063f7dd0ffd832c5e4439f2de30">padded_string_view</a> (const char *s, size_t len, size_t <a class="el" href="classsimdjson_1_1padded__string__view.html#a9d98e1984b893116d8bb7123d84d75b8">capacity</a>) noexcept</td></tr>
<tr class="memdesc:a47ac0063f7dd0ffd832c5e4439f2de30"><td class="mdescLeft">&#160;</td><td class="mdescRight">Promise the given buffer has at least SIMDJSON_PADDING extra bytes allocated to it. <a href="classsimdjson_1_1padded__string__view.html#a47ac0063f7dd0ffd832c5e4439f2de30">More...</a><br /></td></tr>
<tr class="separator:a47ac0063f7dd0ffd832c5e4439f2de30"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a184b54acd28046a9c4f2a6cfa5419779"><td class="memItemLeft" align="right" valign="top"><a id="a184b54acd28046a9c4f2a6cfa5419779"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsimdjson_1_1padded__string__view.html#a184b54acd28046a9c4f2a6cfa5419779">padded_string_view</a> (const uint8_t *s, size_t len, size_t <a class="el" href="classsimdjson_1_1padded__string__view.html#a9d98e1984b893116d8bb7123d84d75b8">capacity</a>) noexcept</td></tr>
<tr class="memdesc:a184b54acd28046a9c4f2a6cfa5419779"><td class="mdescLeft">&#160;</td><td class="mdescRight">overload explicit inline padded_string_view(const char* s, size_t len) noexcept <br /></td></tr>
<tr class="separator:a184b54acd28046a9c4f2a6cfa5419779"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae57856a217294ac218b6372a5e37d9a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsimdjson_1_1padded__string__view.html#aae57856a217294ac218b6372a5e37d9a">padded_string_view</a> (const std::string &amp;s) noexcept</td></tr>
<tr class="memdesc:aae57856a217294ac218b6372a5e37d9a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Promise the given string has at least SIMDJSON_PADDING extra bytes allocated to it. <a href="classsimdjson_1_1padded__string__view.html#aae57856a217294ac218b6372a5e37d9a">More...</a><br /></td></tr>
<tr class="separator:aae57856a217294ac218b6372a5e37d9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a12b33830793e7ab1953b961088a83c3d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsimdjson_1_1padded__string__view.html#a12b33830793e7ab1953b961088a83c3d">padded_string_view</a> (std::string_view s, size_t <a class="el" href="classsimdjson_1_1padded__string__view.html#a9d98e1984b893116d8bb7123d84d75b8">capacity</a>) noexcept</td></tr>
<tr class="memdesc:a12b33830793e7ab1953b961088a83c3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Promise the given string_view has at least SIMDJSON_PADDING extra bytes allocated to it. <a href="classsimdjson_1_1padded__string__view.html#a12b33830793e7ab1953b961088a83c3d">More...</a><br /></td></tr>
<tr class="separator:a12b33830793e7ab1953b961088a83c3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d98e1984b893116d8bb7123d84d75b8"><td class="memItemLeft" align="right" valign="top"><a id="a9d98e1984b893116d8bb7123d84d75b8"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsimdjson_1_1padded__string__view.html#a9d98e1984b893116d8bb7123d84d75b8">capacity</a> () const noexcept</td></tr>
<tr class="memdesc:a9d98e1984b893116d8bb7123d84d75b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of allocated bytes. <br /></td></tr>
<tr class="separator:a9d98e1984b893116d8bb7123d84d75b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a572beea549bf5a58d62ffe4e768c1e82"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsimdjson_1_1padded__string__view.html#a572beea549bf5a58d62ffe4e768c1e82">remove_utf8_bom</a> () noexcept</td></tr>
<tr class="memdesc:a572beea549bf5a58d62ffe4e768c1e82"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove the UTF-8 Byte Order Mark (BOM) if it exists. <a href="classsimdjson_1_1padded__string__view.html#a572beea549bf5a58d62ffe4e768c1e82">More...</a><br /></td></tr>
<tr class="separator:a572beea549bf5a58d62ffe4e768c1e82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a934e7272d22d6024383eafe07b06773c"><td class="memItemLeft" align="right" valign="top"><a id="a934e7272d22d6024383eafe07b06773c"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsimdjson_1_1padded__string__view.html#a934e7272d22d6024383eafe07b06773c">padding</a> () const noexcept</td></tr>
<tr class="memdesc:a934e7272d22d6024383eafe07b06773c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The amount of padding on the string (<a class="el" href="classsimdjson_1_1padded__string__view.html#a9d98e1984b893116d8bb7123d84d75b8" title="The number of allocated bytes.">capacity()</a> - length()) <br /></td></tr>
<tr class="separator:a934e7272d22d6024383eafe07b06773c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>User-provided string that promises it has extra padded bytes at the end for use with parser::parse(). </p>
<p class="definition">Definition at line <a class="el" href="padded__string__view_8h_source.html#l00018">18</a> of file <a class="el" href="padded__string__view_8h_source.html">padded_string_view.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a47ac0063f7dd0ffd832c5e4439f2de30"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47ac0063f7dd0ffd832c5e4439f2de30">&#9670;&nbsp;</a></span>padded_string_view() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">simdjson::padded_string_view::padded_string_view </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>capacity</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">explicit</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Promise the given buffer has at least SIMDJSON_PADDING extra bytes allocated to it. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>The string. </td></tr>
<tr><td class="paramname">len</td><td>The length of the string (not including padding). </td></tr>
<tr><td class="paramname">capacity</td><td>The allocated length of the string, including padding. If the capacity is less than the length, the capacity will be set to the length. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="padded__string__view-inl_8h_source.html#l00011">11</a> of file <a class="el" href="padded__string__view-inl_8h_source.html">padded_string_view-inl.h</a>.</p>
</div>
</div>
<a id="aae57856a217294ac218b6372a5e37d9a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae57856a217294ac218b6372a5e37d9a">&#9670;&nbsp;</a></span>padded_string_view() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">simdjson::padded_string_view::padded_string_view </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>s</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">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Promise the given string has at least SIMDJSON_PADDING extra bytes allocated to it. </p>
<p>The capacity of the string will be used to determine its padding.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>The string. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="padded__string__view-inl_8h_source.html#l00027">27</a> of file <a class="el" href="padded__string__view-inl_8h_source.html">padded_string_view-inl.h</a>.</p>
</div>
</div>
<a id="a12b33830793e7ab1953b961088a83c3d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12b33830793e7ab1953b961088a83c3d">&#9670;&nbsp;</a></span>padded_string_view() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">simdjson::padded_string_view::padded_string_view </td>
<td>(</td>
<td class="paramtype">std::string_view&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>capacity</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">explicit</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Promise the given string_view has at least SIMDJSON_PADDING extra bytes allocated to it. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>The string. </td></tr>
<tr><td class="paramname">capacity</td><td>The allocated length of the string, including padding. If the capacity is less than the length, the capacity will be set to the length. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="padded__string__view-inl_8h_source.html#l00032">32</a> of file <a class="el" href="padded__string__view-inl_8h_source.html">padded_string_view-inl.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a572beea549bf5a58d62ffe4e768c1e82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a572beea549bf5a58d62ffe4e768c1e82">&#9670;&nbsp;</a></span>remove_utf8_bom()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool simdjson::padded_string_view::remove_utf8_bom </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove the UTF-8 Byte Order Mark (BOM) if it exists. </p>
<dl class="section return"><dt>Returns</dt><dd>whether a BOM was found and removed </dd></dl>
<p class="definition">Definition at line <a class="el" href="padded__string__view-inl_8h_source.html#l00042">42</a> of file <a class="el" href="padded__string__view-inl_8h_source.html">padded_string_view-inl.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/simdjson/<a class="el" href="padded__string__view_8h_source.html">padded_string_view.h</a></li>
<li>include/simdjson/<a class="el" href="padded__string__view-inl_8h_source.html">padded_string_view-inl.h</a></li>
</ul>
</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="namespacesimdjson.html">simdjson</a></li><li class="navelem"><a class="el" href="classsimdjson_1_1padded__string__view.html">padded_string_view</a></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.1 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink