| <!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/prost-0.9.0/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.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="../../prost/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="../../prost/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> |
| </pre><pre class="rust"><code><span class="attribute">#![doc(html_root_url = <span class="string">"https://docs.rs/prost/0.9.0"</span>)] |
| #![cfg_attr(not(feature = <span class="string">"std"</span>), no_std)] |
| |
| </span><span class="comment">// Re-export the alloc crate for use within derived code. |
| </span><span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub extern crate </span>alloc; |
| |
| <span class="comment">// Re-export the bytes crate for use within derived code. |
| </span><span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub use </span>bytes; |
| |
| <span class="kw">mod </span>error; |
| <span class="kw">mod </span>message; |
| <span class="kw">mod </span>types; |
| |
| <span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub mod </span>encoding; |
| |
| <span class="kw">pub use </span><span class="kw">crate</span>::error::{DecodeError, EncodeError}; |
| <span class="kw">pub use </span><span class="kw">crate</span>::message::Message; |
| |
| <span class="kw">use </span>bytes::{Buf, BufMut}; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::encoding::{decode_varint, encode_varint, encoded_len_varint}; |
| |
| <span class="comment">// See `encoding::DecodeContext` for more info. |
| // 100 is the default recursion limit in the C++ implementation. |
| </span><span class="attribute">#[cfg(not(feature = <span class="string">"no-recursion-limit"</span>))] |
| </span><span class="kw">const </span>RECURSION_LIMIT: u32 = <span class="number">100</span>; |
| |
| <span class="doccomment">/// Encodes a length delimiter to the buffer. |
| /// |
| /// See [Message.encode_length_delimited] for more info. |
| /// |
| /// An error will be returned if the buffer does not have sufficient capacity to encode the |
| /// delimiter. |
| </span><span class="kw">pub fn </span>encode_length_delimiter<B>(length: usize, buf: <span class="kw-2">&mut </span>B) -> <span class="prelude-ty">Result</span><(), EncodeError> |
| <span class="kw">where |
| </span>B: BufMut, |
| { |
| <span class="kw">let </span>length = length <span class="kw">as </span>u64; |
| <span class="kw">let </span>required = encoded_len_varint(length); |
| <span class="kw">let </span>remaining = buf.remaining_mut(); |
| <span class="kw">if </span>required > remaining { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(EncodeError::new(required, remaining)); |
| } |
| encode_varint(length, buf); |
| <span class="prelude-val">Ok</span>(()) |
| } |
| |
| <span class="doccomment">/// Returns the encoded length of a length delimiter. |
| /// |
| /// Applications may use this method to ensure sufficient buffer capacity before calling |
| /// `encode_length_delimiter`. The returned size will be between 1 and 10, inclusive. |
| </span><span class="kw">pub fn </span>length_delimiter_len(length: usize) -> usize { |
| encoded_len_varint(length <span class="kw">as </span>u64) |
| } |
| |
| <span class="doccomment">/// Decodes a length delimiter from the buffer. |
| /// |
| /// This method allows the length delimiter to be decoded independently of the message, when the |
| /// message is encoded with [Message.encode_length_delimited]. |
| /// |
| /// An error may be returned in two cases: |
| /// |
| /// * If the supplied buffer contains fewer than 10 bytes, then an error indicates that more |
| /// input is required to decode the full delimiter. |
| /// * If the supplied buffer contains more than 10 bytes, then the buffer contains an invalid |
| /// delimiter, and typically the buffer should be considered corrupt. |
| </span><span class="kw">pub fn </span>decode_length_delimiter<B>(<span class="kw-2">mut </span>buf: B) -> <span class="prelude-ty">Result</span><usize, DecodeError> |
| <span class="kw">where |
| </span>B: Buf, |
| { |
| <span class="kw">let </span>length = decode_varint(<span class="kw-2">&mut </span>buf)<span class="question-mark">?</span>; |
| <span class="kw">if </span>length > usize::max_value() <span class="kw">as </span>u64 { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(DecodeError::new( |
| <span class="string">"length delimiter exceeds maximum usize value"</span>, |
| )); |
| } |
| <span class="prelude-val">Ok</span>(length <span class="kw">as </span>usize) |
| } |
| |
| <span class="comment">// Re-export #[derive(Message, Enumeration, Oneof)]. |
| // Based on serde's equivalent re-export [1], but enabled by default. |
| // |
| // [1]: https://github.com/serde-rs/serde/blob/v1.0.89/serde/src/lib.rs#L245-L256 |
| </span><span class="attribute">#[cfg(feature = <span class="string">"prost-derive"</span>)] |
| #[allow(unused_imports)] |
| #[macro_use] |
| </span><span class="kw">extern crate </span>prost_derive; |
| <span class="attribute">#[cfg(feature = <span class="string">"prost-derive"</span>)] |
| #[doc(hidden)] |
| </span><span class="kw">pub use </span>prost_derive::<span class="kw-2">*</span>; |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="prost" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
