| <!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/error.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>error.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> |
| <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> |
| </pre><pre class="rust"><code><span class="doccomment">//! Protobuf encoding and decoding errors. |
| |
| </span><span class="kw">use </span>alloc::borrow::Cow; |
| <span class="kw">use </span>alloc::boxed::Box; |
| <span class="kw">use </span>alloc::vec::Vec; |
| |
| <span class="kw">use </span>core::fmt; |
| |
| <span class="doccomment">/// A Protobuf message decoding error. |
| /// |
| /// `DecodeError` indicates that the input buffer does not caontain a valid |
| /// Protobuf message. The error details should be considered 'best effort': in |
| /// general it is not possible to exactly pinpoint why data is malformed. |
| </span><span class="attribute">#[derive(Clone, PartialEq, Eq)] |
| </span><span class="kw">pub struct </span>DecodeError { |
| inner: Box<Inner>, |
| } |
| |
| <span class="attribute">#[derive(Clone, PartialEq, Eq)] |
| </span><span class="kw">struct </span>Inner { |
| <span class="doccomment">/// A 'best effort' root cause description. |
| </span>description: Cow<<span class="lifetime">'static</span>, str>, |
| <span class="doccomment">/// A stack of (message, field) name pairs, which identify the specific |
| /// message type and field where decoding failed. The stack contains an |
| /// entry per level of nesting. |
| </span>stack: Vec<(<span class="kw-2">&</span><span class="lifetime">'static </span>str, <span class="kw-2">&</span><span class="lifetime">'static </span>str)>, |
| } |
| |
| <span class="kw">impl </span>DecodeError { |
| <span class="doccomment">/// Creates a new `DecodeError` with a 'best effort' root cause description. |
| /// |
| /// Meant to be used only by `Message` implementations. |
| </span><span class="attribute">#[doc(hidden)] |
| #[cold] |
| </span><span class="kw">pub fn </span>new(description: <span class="kw">impl </span>Into<Cow<<span class="lifetime">'static</span>, str>>) -> DecodeError { |
| DecodeError { |
| inner: Box::new(Inner { |
| description: description.into(), |
| stack: Vec::new(), |
| }), |
| } |
| } |
| |
| <span class="doccomment">/// Pushes a (message, field) name location pair on to the location stack. |
| /// |
| /// Meant to be used only by `Message` implementations. |
| </span><span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub fn </span>push(<span class="kw-2">&mut </span><span class="self">self</span>, message: <span class="kw-2">&</span><span class="lifetime">'static </span>str, field: <span class="kw-2">&</span><span class="lifetime">'static </span>str) { |
| <span class="self">self</span>.inner.stack.push((message, field)); |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>DecodeError { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| f.debug_struct(<span class="string">"DecodeError"</span>) |
| .field(<span class="string">"description"</span>, <span class="kw-2">&</span><span class="self">self</span>.inner.description) |
| .field(<span class="string">"stack"</span>, <span class="kw-2">&</span><span class="self">self</span>.inner.stack) |
| .finish() |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Display <span class="kw">for </span>DecodeError { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| f.write_str(<span class="string">"failed to decode Protobuf message: "</span>)<span class="question-mark">?</span>; |
| <span class="kw">for </span><span class="kw-2">&</span>(message, field) <span class="kw">in </span><span class="kw-2">&</span><span class="self">self</span>.inner.stack { |
| <span class="macro">write!</span>(f, <span class="string">"{}.{}: "</span>, message, field)<span class="question-mark">?</span>; |
| } |
| f.write_str(<span class="kw-2">&</span><span class="self">self</span>.inner.description) |
| } |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">impl </span>std::error::Error <span class="kw">for </span>DecodeError {} |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">impl </span>From<DecodeError> <span class="kw">for </span>std::io::Error { |
| <span class="kw">fn </span>from(error: DecodeError) -> std::io::Error { |
| std::io::Error::new(std::io::ErrorKind::InvalidData, error) |
| } |
| } |
| |
| <span class="doccomment">/// A Protobuf message encoding error. |
| /// |
| /// `EncodeError` always indicates that a message failed to encode because the |
| /// provided buffer had insufficient capacity. Message encoding is otherwise |
| /// infallible. |
| </span><span class="attribute">#[derive(Copy, Clone, Debug, PartialEq, Eq)] |
| </span><span class="kw">pub struct </span>EncodeError { |
| required: usize, |
| remaining: usize, |
| } |
| |
| <span class="kw">impl </span>EncodeError { |
| <span class="doccomment">/// Creates a new `EncodeError`. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new(required: usize, remaining: usize) -> EncodeError { |
| EncodeError { |
| required, |
| remaining, |
| } |
| } |
| |
| <span class="doccomment">/// Returns the required buffer capacity to encode the message. |
| </span><span class="kw">pub fn </span>required_capacity(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.required |
| } |
| |
| <span class="doccomment">/// Returns the remaining length in the provided buffer at the time of encoding. |
| </span><span class="kw">pub fn </span>remaining(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.remaining |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Display <span class="kw">for </span>EncodeError { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| <span class="macro">write!</span>( |
| f, |
| <span class="string">"failed to encode Protobuf messsage; insufficient buffer capacity (required: {}, remaining: {})"</span>, |
| <span class="self">self</span>.required, <span class="self">self</span>.remaining |
| ) |
| } |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">impl </span>std::error::Error <span class="kw">for </span>EncodeError {} |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">impl </span>From<EncodeError> <span class="kw">for </span>std::io::Error { |
| <span class="kw">fn </span>from(error: EncodeError) -> std::io::Error { |
| std::io::Error::new(std::io::ErrorKind::InvalidInput, error) |
| } |
| } |
| </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> |
