blob: 83ccc548e1737c5a3df71e47a4b95fa7be3b67f9 [file] [log] [blame]
<!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>Kudu C++ client API: kudu::Slice 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="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 id="projectrow">
<td id="projectalign">
<div id="projectname">Kudu C++ client API
</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&amp;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&amp;dn=expat.txt MIT */
$(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">
<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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>kudu</b></li><li class="navelem"><a class="el" href="classkudu_1_1Slice.html">Slice</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classkudu_1_1Slice-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">kudu::Slice Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A wrapper around externally allocated data.
<a href="classkudu_1_1Slice.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="slice_8h_source.html">slice.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structkudu_1_1Slice_1_1Comparator.html">Comparator</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structkudu_1_1Slice_1_1Comparator.html" title="Comparator struct, useful for ordered collections (like STL maps).">Comparator</a> struct, useful for ordered collections (like STL maps). <a href="structkudu_1_1Slice_1_1Comparator.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aaee66c59ee434349680679bdf0462b66" id="r_aaee66c59ee434349680679bdf0462b66"><td class="memItemLeft" align="right" valign="top"><a id="aaee66c59ee434349680679bdf0462b66" name="aaee66c59ee434349680679bdf0462b66"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Slice</b> ()</td></tr>
<tr class="memdesc:aaee66c59ee434349680679bdf0462b66"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an empty slice. <br /></td></tr>
<tr class="separator:aaee66c59ee434349680679bdf0462b66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a904b8732b247676c52cbd9147b34c54c" id="r_a904b8732b247676c52cbd9147b34c54c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1Slice.html#a904b8732b247676c52cbd9147b34c54c">Slice</a> (const uint8_t *d, size_t n)</td></tr>
<tr class="separator:a904b8732b247676c52cbd9147b34c54c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9cb396203dd2c589e7d4f10bd80461d5" id="r_a9cb396203dd2c589e7d4f10bd80461d5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1Slice.html#a9cb396203dd2c589e7d4f10bd80461d5">Slice</a> (const char *d, size_t n)</td></tr>
<tr class="separator:a9cb396203dd2c589e7d4f10bd80461d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13838e07b6dcea1895a774ab1ba62bdd" id="r_a13838e07b6dcea1895a774ab1ba62bdd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1Slice.html#a13838e07b6dcea1895a774ab1ba62bdd">Slice</a> (const std::string &amp;s)</td></tr>
<tr class="separator:a13838e07b6dcea1895a774ab1ba62bdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8c6057eea15f8136e62255fd766e345" id="r_ae8c6057eea15f8136e62255fd766e345"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1Slice.html#ae8c6057eea15f8136e62255fd766e345">Slice</a> (const char *s)</td></tr>
<tr class="separator:ae8c6057eea15f8136e62255fd766e345"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a59229b682987a54954ec2fe5b1a9f9e5" id="r_a59229b682987a54954ec2fe5b1a9f9e5"><td class="memItemLeft" align="right" valign="top">const uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1Slice.html#a59229b682987a54954ec2fe5b1a9f9e5">data</a> () const</td></tr>
<tr class="separator:a59229b682987a54954ec2fe5b1a9f9e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f61bd09972202051bd1f78fb7497705" id="r_a3f61bd09972202051bd1f78fb7497705"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1Slice.html#a3f61bd09972202051bd1f78fb7497705">mutable_data</a> ()</td></tr>
<tr class="separator:a3f61bd09972202051bd1f78fb7497705"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec1c45dc306dce4a0977fff8eabdb433" id="r_aec1c45dc306dce4a0977fff8eabdb433"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1Slice.html#aec1c45dc306dce4a0977fff8eabdb433">size</a> () const</td></tr>
<tr class="separator:aec1c45dc306dce4a0977fff8eabdb433"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a072af6f4ad1aef904c5f683107d0e523" id="r_a072af6f4ad1aef904c5f683107d0e523"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1Slice.html#a072af6f4ad1aef904c5f683107d0e523">empty</a> () const</td></tr>
<tr class="separator:a072af6f4ad1aef904c5f683107d0e523"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65178d88db9bc2440b20fe6f6de0d723" id="r_a65178d88db9bc2440b20fe6f6de0d723"><td class="memItemLeft" align="right" valign="top">const uint8_t &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1Slice.html#a65178d88db9bc2440b20fe6f6de0d723">operator[]</a> (size_t n) const</td></tr>
<tr class="separator:a65178d88db9bc2440b20fe6f6de0d723"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb914c0769f019a7c2f28b755cba5eb5" id="r_afb914c0769f019a7c2f28b755cba5eb5"><td class="memItemLeft" align="right" valign="top"><a id="afb914c0769f019a7c2f28b755cba5eb5" name="afb914c0769f019a7c2f28b755cba5eb5"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>clear</b> ()</td></tr>
<tr class="memdesc:afb914c0769f019a7c2f28b755cba5eb5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Change this slice to refer to an empty array. <br /></td></tr>
<tr class="separator:afb914c0769f019a7c2f28b755cba5eb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00f5d310f9ebf17c198cf3feb69c3842" id="r_a00f5d310f9ebf17c198cf3feb69c3842"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1Slice.html#a00f5d310f9ebf17c198cf3feb69c3842">remove_prefix</a> (size_t n)</td></tr>
<tr class="separator:a00f5d310f9ebf17c198cf3feb69c3842"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20f1c8e91ff0209e5c8f86766ef63d44" id="r_a20f1c8e91ff0209e5c8f86766ef63d44"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1Slice.html#a20f1c8e91ff0209e5c8f86766ef63d44">truncate</a> (size_t n)</td></tr>
<tr class="separator:a20f1c8e91ff0209e5c8f86766ef63d44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48bc614a10aba1268eae9a7054bf5f9e" id="r_a48bc614a10aba1268eae9a7054bf5f9e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkudu_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1Slice.html#a48bc614a10aba1268eae9a7054bf5f9e">check_size</a> (size_t expected_size) const</td></tr>
<tr class="separator:a48bc614a10aba1268eae9a7054bf5f9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01ad84246c80f91b5b7634b0346c4a03" id="r_a01ad84246c80f91b5b7634b0346c4a03"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1Slice.html#a01ad84246c80f91b5b7634b0346c4a03">ToString</a> () const</td></tr>
<tr class="separator:a01ad84246c80f91b5b7634b0346c4a03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2f077da829e931314a753bc6b76fbf7" id="r_ad2f077da829e931314a753bc6b76fbf7"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1Slice.html#ad2f077da829e931314a753bc6b76fbf7">ToDebugString</a> (size_t max_len=0) const</td></tr>
<tr class="separator:ad2f077da829e931314a753bc6b76fbf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e5fabfcb85d2076297aa3c24ba448c2" id="r_a6e5fabfcb85d2076297aa3c24ba448c2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1Slice.html#a6e5fabfcb85d2076297aa3c24ba448c2">compare</a> (const <a class="el" href="classkudu_1_1Slice.html">Slice</a> &amp;b) const</td></tr>
<tr class="separator:a6e5fabfcb85d2076297aa3c24ba448c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1919baa9e854b50b938c35bd1686c9d" id="r_ab1919baa9e854b50b938c35bd1686c9d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1Slice.html#ab1919baa9e854b50b938c35bd1686c9d">starts_with</a> (const <a class="el" href="classkudu_1_1Slice.html">Slice</a> &amp;x) const</td></tr>
<tr class="separator:ab1919baa9e854b50b938c35bd1686c9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4bb1c9fe13873623b5a5a118830b1806" id="r_a4bb1c9fe13873623b5a5a118830b1806"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1Slice.html#a4bb1c9fe13873623b5a5a118830b1806">relocate</a> (uint8_t *d)</td></tr>
<tr class="separator:a4bb1c9fe13873623b5a5a118830b1806"><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>A wrapper around externally allocated data. </p>
<p><a class="el" href="classkudu_1_1Slice.html" title="A wrapper around externally allocated data.">Slice</a> is a simple structure containing a pointer into some external storage and a size. The user of a <a class="el" href="classkudu_1_1Slice.html" title="A wrapper around externally allocated data.">Slice</a> must ensure that the slice is not used after the corresponding external storage has been deallocated.</p>
<p>Multiple threads can invoke const methods on a <a class="el" href="classkudu_1_1Slice.html" title="A wrapper around externally allocated data.">Slice</a> without external synchronization, but if any of the threads may call a non-const method, all threads accessing the same <a class="el" href="classkudu_1_1Slice.html" title="A wrapper around externally allocated data.">Slice</a> must use external synchronization.</p>
<p>Slices can be built around faststrings and StringPieces using constructors with implicit casts. Both StringPieces and faststrings depend on a great deal of gutil code. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a904b8732b247676c52cbd9147b34c54c" name="a904b8732b247676c52cbd9147b34c54c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a904b8732b247676c52cbd9147b34c54c">&#9670;&#160;</a></span>Slice() <span class="overload">[1/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">kudu::Slice::Slice </td>
<td>(</td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>d</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>n</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a slice that refers to a <code>uint8_t</code> byte array.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">d</td><td>The input array. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Number of bytes in the array. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9cb396203dd2c589e7d4f10bd80461d5" name="a9cb396203dd2c589e7d4f10bd80461d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9cb396203dd2c589e7d4f10bd80461d5">&#9670;&#160;</a></span>Slice() <span class="overload">[2/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">kudu::Slice::Slice </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>d</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>n</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a slice that refers to a <code>char</code> byte array.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">d</td><td>The input array. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Number of bytes in the array. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a13838e07b6dcea1895a774ab1ba62bdd" name="a13838e07b6dcea1895a774ab1ba62bdd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a13838e07b6dcea1895a774ab1ba62bdd">&#9670;&#160;</a></span>Slice() <span class="overload">[3/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">kudu::Slice::Slice </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a slice that refers to the contents of the given string.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>The input string. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae8c6057eea15f8136e62255fd766e345" name="ae8c6057eea15f8136e62255fd766e345"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8c6057eea15f8136e62255fd766e345">&#9670;&#160;</a></span>Slice() <span class="overload">[4/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">kudu::Slice::Slice </td>
<td>(</td>
<td class="paramtype">const char *&#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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a slice that refers to a C-string s[0,strlen(s)-1].</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>The input C-string. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a48bc614a10aba1268eae9a7054bf5f9e" name="a48bc614a10aba1268eae9a7054bf5f9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48bc614a10aba1268eae9a7054bf5f9e">&#9670;&#160;</a></span>check_size()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classkudu_1_1Status.html">Status</a> kudu::Slice::check_size </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>expected_size</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Check that the slice has the expected size.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">expected_size</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classkudu_1_1Status.html#a5c0ed04aa8234b9c1aedeafc4dd3d2ee">Status::Corruption()</a> iff <a class="el" href="classkudu_1_1Slice.html#aec1c45dc306dce4a0977fff8eabdb433">size()</a> != <code>expected_size</code> </dd></dl>
</div>
</div>
<a id="a6e5fabfcb85d2076297aa3c24ba448c2" name="a6e5fabfcb85d2076297aa3c24ba448c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e5fabfcb85d2076297aa3c24ba448c2">&#9670;&#160;</a></span>compare()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int kudu::Slice::compare </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classkudu_1_1Slice.html">Slice</a> &amp;&#160;</td>
<td class="paramname"><em>b</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Do a three-way comparison of the slice's data.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>The other slice to compare with. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Values are <ul>
<li>&lt; 0 iff "*this" &lt; "b" </li>
<li>== 0 iff "*this" == "b" </li>
<li>&gt; 0 iff "*this" &gt; "b" </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a59229b682987a54954ec2fe5b1a9f9e5" name="a59229b682987a54954ec2fe5b1a9f9e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59229b682987a54954ec2fe5b1a9f9e5">&#9670;&#160;</a></span>data()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const uint8_t * kudu::Slice::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> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>A pointer to the beginning of the referenced data. </dd></dl>
</div>
</div>
<a id="a072af6f4ad1aef904c5f683107d0e523" name="a072af6f4ad1aef904c5f683107d0e523"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a072af6f4ad1aef904c5f683107d0e523">&#9670;&#160;</a></span>empty()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool kudu::Slice::empty </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> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd><code>true</code> iff the length of the referenced data is zero. </dd></dl>
</div>
</div>
<a id="a3f61bd09972202051bd1f78fb7497705" name="a3f61bd09972202051bd1f78fb7497705"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f61bd09972202051bd1f78fb7497705">&#9670;&#160;</a></span>mutable_data()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t * kudu::Slice::mutable_data </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> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>A mutable pointer to the beginning of the referenced data. </dd></dl>
</div>
</div>
<a id="a65178d88db9bc2440b20fe6f6de0d723" name="a65178d88db9bc2440b20fe6f6de0d723"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65178d88db9bc2440b20fe6f6de0d723">&#9670;&#160;</a></span>operator[]()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const uint8_t &amp; kudu::Slice::operator[] </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>n</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section pre"><dt>Precondition</dt><dd>n &lt; <a class="el" href="classkudu_1_1Slice.html#aec1c45dc306dce4a0977fff8eabdb433">size()</a></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>The index of the byte. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the n-th byte in the referenced data. </dd></dl>
</div>
</div>
<a id="a4bb1c9fe13873623b5a5a118830b1806" name="a4bb1c9fe13873623b5a5a118830b1806"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bb1c9fe13873623b5a5a118830b1806">&#9670;&#160;</a></span>relocate()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void kudu::Slice::relocate </td>
<td>(</td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>d</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Relocate/copy the slice's data into a new location.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">d</td><td>The new location for the data. If it's the same location, then no relocation is done. It is assumed that the new location is large enough to fit the data. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a00f5d310f9ebf17c198cf3feb69c3842" name="a00f5d310f9ebf17c198cf3feb69c3842"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a00f5d310f9ebf17c198cf3feb69c3842">&#9670;&#160;</a></span>remove_prefix()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void kudu::Slice::remove_prefix </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>n</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Drop the first "n" bytes from this slice.</p>
<dl class="section pre"><dt>Precondition</dt><dd>n &lt;= <a class="el" href="classkudu_1_1Slice.html#aec1c45dc306dce4a0977fff8eabdb433">size()</a></dd></dl>
<dl class="section note"><dt>Note</dt><dd>Only the base and bounds of the slice are changed; the data is not modified.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Number of bytes that should be dropped from the beginning. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aec1c45dc306dce4a0977fff8eabdb433" name="aec1c45dc306dce4a0977fff8eabdb433"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec1c45dc306dce4a0977fff8eabdb433">&#9670;&#160;</a></span>size()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t kudu::Slice::size </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> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>The length (in bytes) of the referenced data. </dd></dl>
</div>
</div>
<a id="ab1919baa9e854b50b938c35bd1686c9d" name="ab1919baa9e854b50b938c35bd1686c9d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab1919baa9e854b50b938c35bd1686c9d">&#9670;&#160;</a></span>starts_with()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool kudu::Slice::starts_with </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classkudu_1_1Slice.html">Slice</a> &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether the slice starts with the given prefix. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>The slice in question. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> iff "x" is a prefix of "*this" </dd></dl>
</div>
</div>
<a id="ad2f077da829e931314a753bc6b76fbf7" name="ad2f077da829e931314a753bc6b76fbf7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2f077da829e931314a753bc6b76fbf7">&#9670;&#160;</a></span>ToDebugString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string kudu::Slice::ToDebugString </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>max_len</em> = <code>0</code></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get printable representation of the data in the slice.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">max_len</td><td>The maximum number of bytes to output in the printable format; <code>0</code> means no limit. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A string with printable representation of the data. </dd></dl>
</div>
</div>
<a id="a01ad84246c80f91b5b7634b0346c4a03" name="a01ad84246c80f91b5b7634b0346c4a03"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01ad84246c80f91b5b7634b0346c4a03">&#9670;&#160;</a></span>ToString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string kudu::Slice::ToString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>A string that contains a copy of the referenced data. </dd></dl>
</div>
</div>
<a id="a20f1c8e91ff0209e5c8f86766ef63d44" name="a20f1c8e91ff0209e5c8f86766ef63d44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20f1c8e91ff0209e5c8f86766ef63d44">&#9670;&#160;</a></span>truncate()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void kudu::Slice::truncate </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>n</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Truncate the slice to the given number of bytes.</p>
<dl class="section pre"><dt>Precondition</dt><dd>n &lt;= <a class="el" href="classkudu_1_1Slice.html#aec1c45dc306dce4a0977fff8eabdb433">size()</a></dd></dl>
<dl class="section note"><dt>Note</dt><dd>Only the base and bounds of the slice are changed; the data is not modified.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>The new size of the slice. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/kudu/util/<a class="el" href="slice_8h_source.html">slice.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/>
<address class="footer">
<small>Generated for Kudu version 1.17.0 on Mon Sep 4 2023 19:49:30 by Doxygen 1.9.8</small>
<br>
<small>Copyright © 2023 The Apache Software Foundation.</small>
</address>
</body>
</html>