| <!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/git/checkouts/incubator-teaclave-crates-c8106113f74feefc/ede1f68/rustls-0.19.1/rustls/src/msgs/fragmenter.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>fragmenter.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="../../../rustls/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../rustls/index.html"><img class="rust-logo" src="../../../rust-logo.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> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| </pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::msgs::enums::{ContentType, ProtocolVersion}; |
| <span class="kw">use </span><span class="kw">crate</span>::msgs::message::{BorrowMessage, Message, MessagePayload}; |
| <span class="kw">use </span>std::collections::VecDeque; |
| |
| <span class="kw">pub const </span>MAX_FRAGMENT_LEN: usize = <span class="number">16384</span>; |
| <span class="kw">pub const </span>PACKET_OVERHEAD: usize = <span class="number">1 </span>+ <span class="number">2 </span>+ <span class="number">2</span>; |
| |
| <span class="kw">pub struct </span>MessageFragmenter { |
| max_frag: usize, |
| } |
| |
| <span class="kw">impl </span>MessageFragmenter { |
| <span class="doccomment">/// Make a new fragmenter. `max_fragment_len` is the maximum |
| /// fragment size that will be produced -- this does not |
| /// include overhead (so a `max_fragment_len` of 5 will produce |
| /// 10 byte packets). |
| </span><span class="kw">pub fn </span>new(max_fragment_len: usize) -> MessageFragmenter { |
| <span class="macro">debug_assert!</span>(max_fragment_len <= MAX_FRAGMENT_LEN); |
| MessageFragmenter { |
| max_frag: max_fragment_len, |
| } |
| } |
| |
| <span class="doccomment">/// Take the Message `msg` and re-fragment it into new |
| /// messages whose fragment is no more than max_frag. |
| /// The new messages are appended to the `out` deque. |
| /// Payloads are copied. |
| </span><span class="kw">pub fn </span>fragment(<span class="kw-2">&</span><span class="self">self</span>, msg: Message, out: <span class="kw-2">&mut </span>VecDeque<Message>) { |
| <span class="comment">// Non-fragment path |
| </span><span class="kw">if </span>msg.payload.length() <= <span class="self">self</span>.max_frag { |
| out.push_back(msg.into_opaque()); |
| <span class="kw">return</span>; |
| } |
| |
| <span class="kw">let </span>typ = msg.typ; |
| <span class="kw">let </span>version = msg.version; |
| <span class="kw">let </span>payload = msg.take_payload(); |
| |
| <span class="kw">for </span>chunk <span class="kw">in </span>payload.chunks(<span class="self">self</span>.max_frag) { |
| <span class="kw">let </span>m = Message { |
| typ, |
| version, |
| payload: MessagePayload::new_opaque(chunk.to_vec()), |
| }; |
| out.push_back(m); |
| } |
| } |
| |
| <span class="doccomment">/// Enqueue borrowed fragments of (version, typ, payload) which |
| /// are no longer than max_frag onto the `out` deque. |
| </span><span class="kw">pub fn </span>fragment_borrow<<span class="lifetime">'a</span>>( |
| <span class="kw-2">&</span><span class="self">self</span>, |
| typ: ContentType, |
| version: ProtocolVersion, |
| payload: <span class="kw-2">&</span><span class="lifetime">'a </span>[u8], |
| out: <span class="kw-2">&mut </span>VecDeque<BorrowMessage<<span class="lifetime">'a</span>>>, |
| ) { |
| <span class="kw">for </span>chunk <span class="kw">in </span>payload.chunks(<span class="self">self</span>.max_frag) { |
| <span class="kw">let </span>cm = BorrowMessage { |
| typ, |
| version, |
| payload: chunk, |
| }; |
| out.push_back(cm); |
| } |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use super</span>::{MessageFragmenter, PACKET_OVERHEAD}; |
| <span class="kw">use </span><span class="kw">crate</span>::msgs::codec::Codec; |
| <span class="kw">use </span><span class="kw">crate</span>::msgs::enums::{ContentType, ProtocolVersion}; |
| <span class="kw">use </span><span class="kw">crate</span>::msgs::message::{Message, MessagePayload}; |
| <span class="kw">use </span>std::collections::VecDeque; |
| |
| <span class="kw">fn </span>msg_eq( |
| mm: <span class="prelude-ty">Option</span><Message>, |
| total_len: usize, |
| typ: <span class="kw-2">&</span>ContentType, |
| version: <span class="kw-2">&</span>ProtocolVersion, |
| bytes: <span class="kw-2">&</span>[u8], |
| ) { |
| <span class="kw">let </span><span class="kw-2">mut </span>m = mm.unwrap(); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = Vec::new(); |
| m.encode(<span class="kw-2">&mut </span>buf); |
| |
| <span class="macro">assert_eq!</span>(<span class="kw-2">&</span>m.typ, typ); |
| <span class="macro">assert_eq!</span>(<span class="kw-2">&</span>m.version, version); |
| <span class="macro">assert_eq!</span>(m.take_opaque_payload().unwrap().<span class="number">0</span>, bytes.to_vec()); |
| |
| <span class="macro">assert_eq!</span>(total_len, buf.len()); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>smoke() { |
| <span class="kw">let </span>typ = ContentType::Handshake; |
| <span class="kw">let </span>version = ProtocolVersion::TLSv1_2; |
| <span class="kw">let </span>m = Message { |
| typ, |
| version, |
| payload: MessagePayload::new_opaque(<span class="string">b"\x01\x02\x03\x04\x05\x06\x07\x08"</span>.to_vec()), |
| }; |
| |
| <span class="kw">let </span>frag = MessageFragmenter::new(<span class="number">3</span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>q = VecDeque::new(); |
| frag.fragment(m, <span class="kw-2">&mut </span>q); |
| msg_eq( |
| q.pop_front(), |
| PACKET_OVERHEAD + <span class="number">3</span>, |
| <span class="kw-2">&</span>typ, |
| <span class="kw-2">&</span>version, |
| <span class="string">b"\x01\x02\x03"</span>, |
| ); |
| msg_eq( |
| q.pop_front(), |
| PACKET_OVERHEAD + <span class="number">3</span>, |
| <span class="kw-2">&</span>typ, |
| <span class="kw-2">&</span>version, |
| <span class="string">b"\x04\x05\x06"</span>, |
| ); |
| msg_eq( |
| q.pop_front(), |
| PACKET_OVERHEAD + <span class="number">2</span>, |
| <span class="kw-2">&</span>typ, |
| <span class="kw-2">&</span>version, |
| <span class="string">b"\x07\x08"</span>, |
| ); |
| <span class="macro">assert_eq!</span>(q.len(), <span class="number">0</span>); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>non_fragment() { |
| <span class="kw">let </span>m = Message { |
| typ: ContentType::Handshake, |
| version: ProtocolVersion::TLSv1_2, |
| payload: MessagePayload::new_opaque(<span class="string">b"\x01\x02\x03\x04\x05\x06\x07\x08"</span>.to_vec()), |
| }; |
| |
| <span class="kw">let </span>frag = MessageFragmenter::new(<span class="number">8</span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>q = VecDeque::new(); |
| frag.fragment(m, <span class="kw-2">&mut </span>q); |
| msg_eq( |
| q.pop_front(), |
| PACKET_OVERHEAD + <span class="number">8</span>, |
| <span class="kw-2">&</span>ContentType::Handshake, |
| <span class="kw-2">&</span>ProtocolVersion::TLSv1_2, |
| <span class="string">b"\x01\x02\x03\x04\x05\x06\x07\x08"</span>, |
| ); |
| <span class="macro">assert_eq!</span>(q.len(), <span class="number">0</span>); |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="rustls" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
