Google Git
Sign in
apache / incubator-teaclave-website / refs/heads/asf-site / . / api-docs / crates-enclave / src / tonic / codec / buffer.rs.html
blob: f4145275456c84073aa73de4407d0c54f0056f04 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/tonic-0.6.2/src/codec/buffer.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>buffer.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../tonic/index.html"><div class="logo-container">
<img src="https://raw.githubusercontent.com/tokio-rs/website/master/public/img/icons/tonic.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../tonic/index.html">
<img src="https://raw.githubusercontent.com/tokio-rs/website/master/public/img/icons/tonic.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
</pre><pre class="rust"><code><span class="kw">use </span>bytes::buf::UninitSlice;
<span class="kw">use </span>bytes::{Buf, BufMut, BytesMut};
<span class="doccomment">/// A specialized buffer to decode gRPC messages from.
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>DecodeBuf&lt;<span class="lifetime">&#39;a</span>&gt; {
buf: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span>BytesMut,
len: usize,
}
<span class="doccomment">/// A specialized buffer to encode gRPC messages into.
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>EncodeBuf&lt;<span class="lifetime">&#39;a</span>&gt; {
buf: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span>BytesMut,
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; DecodeBuf&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new(buf: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span>BytesMut, len: usize) -&gt; <span class="self">Self </span>{
DecodeBuf { buf, len }
}
}
<span class="kw">impl </span>Buf <span class="kw">for </span>DecodeBuf&lt;<span class="lifetime">&#39;_</span>&gt; {
<span class="attribute">#[inline]
</span><span class="kw">fn </span>remaining(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.len
}
<span class="attribute">#[inline]
</span><span class="kw">fn </span>chunk(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>[u8] {
<span class="kw">let </span>ret = <span class="self">self</span>.buf.chunk();
<span class="kw">if </span>ret.len() &gt; <span class="self">self</span>.len {
<span class="kw-2">&amp;</span>ret[..<span class="self">self</span>.len]
} <span class="kw">else </span>{
ret
}
}
<span class="attribute">#[inline]
</span><span class="kw">fn </span>advance(<span class="kw-2">&amp;mut </span><span class="self">self</span>, cnt: usize) {
<span class="macro">assert!</span>(cnt &lt;= <span class="self">self</span>.len);
<span class="self">self</span>.buf.advance(cnt);
<span class="self">self</span>.len -= cnt;
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; EncodeBuf&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new(buf: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span>BytesMut) -&gt; <span class="self">Self </span>{
EncodeBuf { buf }
}
}
<span class="kw">impl </span>EncodeBuf&lt;<span class="lifetime">&#39;_</span>&gt; {
<span class="doccomment">/// Reserves capacity for at least `additional` more bytes to be inserted
/// into the buffer.
///
/// More than `additional` bytes may be reserved in order to avoid frequent
/// reallocations. A call to `reserve` may result in an allocation.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>reserve(<span class="kw-2">&amp;mut </span><span class="self">self</span>, additional: usize) {
<span class="self">self</span>.buf.reserve(additional);
}
}
<span class="kw">unsafe impl </span>BufMut <span class="kw">for </span>EncodeBuf&lt;<span class="lifetime">&#39;_</span>&gt; {
<span class="attribute">#[inline]
</span><span class="kw">fn </span>remaining_mut(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.buf.remaining_mut()
}
<span class="attribute">#[inline]
</span><span class="kw">unsafe fn </span>advance_mut(<span class="kw-2">&amp;mut </span><span class="self">self</span>, cnt: usize) {
<span class="self">self</span>.buf.advance_mut(cnt)
}
<span class="attribute">#[inline]
</span><span class="kw">fn </span>chunk_mut(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;mut </span>UninitSlice {
<span class="self">self</span>.buf.chunk_mut()
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="attribute">#[test]
</span><span class="kw">fn </span>decode_buf() {
<span class="kw">let </span><span class="kw-2">mut </span>payload = BytesMut::with_capacity(<span class="number">100</span>);
payload.put(<span class="kw-2">&amp;</span><span class="macro">vec!</span>[<span class="number">0u8</span>; <span class="number">50</span>][..]);
<span class="kw">let </span><span class="kw-2">mut </span>buf = DecodeBuf::new(<span class="kw-2">&amp;mut </span>payload, <span class="number">20</span>);
<span class="macro">assert_eq!</span>(buf.len, <span class="number">20</span>);
<span class="macro">assert_eq!</span>(buf.remaining(), <span class="number">20</span>);
<span class="macro">assert_eq!</span>(buf.chunk().len(), <span class="number">20</span>);
buf.advance(<span class="number">10</span>);
<span class="macro">assert_eq!</span>(buf.remaining(), <span class="number">10</span>);
<span class="kw">let </span><span class="kw-2">mut </span>out = [<span class="number">0</span>; <span class="number">5</span>];
buf.copy_to_slice(<span class="kw-2">&amp;mut </span>out);
<span class="macro">assert_eq!</span>(buf.remaining(), <span class="number">5</span>);
<span class="macro">assert_eq!</span>(buf.chunk().len(), <span class="number">5</span>);
<span class="macro">assert_eq!</span>(buf.copy_to_bytes(<span class="number">5</span>).len(), <span class="number">5</span>);
<span class="macro">assert!</span>(!buf.has_remaining());
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>encode_buf() {
<span class="kw">let </span><span class="kw-2">mut </span>bytes = BytesMut::with_capacity(<span class="number">100</span>);
<span class="kw">let </span><span class="kw-2">mut </span>buf = EncodeBuf::new(<span class="kw-2">&amp;mut </span>bytes);
<span class="kw">let </span>initial = buf.remaining_mut();
<span class="kw">unsafe </span>{ buf.advance_mut(<span class="number">20</span>) };
<span class="macro">assert_eq!</span>(buf.remaining_mut(), initial - <span class="number">20</span>);
buf.put_u8(<span class="string">b&#39;a&#39;</span>);
<span class="macro">assert_eq!</span>(buf.remaining_mut(), initial - <span class="number">20 </span>- <span class="number">1</span>);
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="tonic" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>