| <!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/image/./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="../../image/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="../../image/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> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| <span id="222">222</span> |
| <span id="223">223</span> |
| <span id="224">224</span> |
| <span id="225">225</span> |
| <span id="226">226</span> |
| <span id="227">227</span> |
| <span id="228">228</span> |
| <span id="229">229</span> |
| <span id="230">230</span> |
| <span id="231">231</span> |
| <span id="232">232</span> |
| <span id="233">233</span> |
| <span id="234">234</span> |
| <span id="235">235</span> |
| <span id="236">236</span> |
| <span id="237">237</span> |
| <span id="238">238</span> |
| <span id="239">239</span> |
| <span id="240">240</span> |
| <span id="241">241</span> |
| <span id="242">242</span> |
| <span id="243">243</span> |
| <span id="244">244</span> |
| <span id="245">245</span> |
| <span id="246">246</span> |
| <span id="247">247</span> |
| <span id="248">248</span> |
| <span id="249">249</span> |
| <span id="250">250</span> |
| <span id="251">251</span> |
| <span id="252">252</span> |
| <span id="253">253</span> |
| <span id="254">254</span> |
| <span id="255">255</span> |
| <span id="256">256</span> |
| <span id="257">257</span> |
| <span id="258">258</span> |
| <span id="259">259</span> |
| <span id="260">260</span> |
| <span id="261">261</span> |
| <span id="262">262</span> |
| <span id="263">263</span> |
| <span id="264">264</span> |
| <span id="265">265</span> |
| <span id="266">266</span> |
| <span id="267">267</span> |
| <span id="268">268</span> |
| <span id="269">269</span> |
| <span id="270">270</span> |
| <span id="271">271</span> |
| <span id="272">272</span> |
| <span id="273">273</span> |
| <span id="274">274</span> |
| <span id="275">275</span> |
| <span id="276">276</span> |
| <span id="277">277</span> |
| <span id="278">278</span> |
| <span id="279">279</span> |
| <span id="280">280</span> |
| <span id="281">281</span> |
| <span id="282">282</span> |
| <span id="283">283</span> |
| <span id="284">284</span> |
| <span id="285">285</span> |
| <span id="286">286</span> |
| <span id="287">287</span> |
| <span id="288">288</span> |
| <span id="289">289</span> |
| <span id="290">290</span> |
| <span id="291">291</span> |
| <span id="292">292</span> |
| <span id="293">293</span> |
| <span id="294">294</span> |
| <span id="295">295</span> |
| <span id="296">296</span> |
| <span id="297">297</span> |
| <span id="298">298</span> |
| <span id="299">299</span> |
| <span id="300">300</span> |
| <span id="301">301</span> |
| <span id="302">302</span> |
| <span id="303">303</span> |
| <span id="304">304</span> |
| <span id="305">305</span> |
| <span id="306">306</span> |
| <span id="307">307</span> |
| <span id="308">308</span> |
| <span id="309">309</span> |
| <span id="310">310</span> |
| <span id="311">311</span> |
| <span id="312">312</span> |
| <span id="313">313</span> |
| <span id="314">314</span> |
| <span id="315">315</span> |
| <span id="316">316</span> |
| <span id="317">317</span> |
| <span id="318">318</span> |
| <span id="319">319</span> |
| <span id="320">320</span> |
| <span id="321">321</span> |
| <span id="322">322</span> |
| <span id="323">323</span> |
| <span id="324">324</span> |
| <span id="325">325</span> |
| <span id="326">326</span> |
| <span id="327">327</span> |
| <span id="328">328</span> |
| <span id="329">329</span> |
| <span id="330">330</span> |
| <span id="331">331</span> |
| <span id="332">332</span> |
| <span id="333">333</span> |
| <span id="334">334</span> |
| <span id="335">335</span> |
| <span id="336">336</span> |
| <span id="337">337</span> |
| <span id="338">338</span> |
| <span id="339">339</span> |
| <span id="340">340</span> |
| <span id="341">341</span> |
| <span id="342">342</span> |
| <span id="343">343</span> |
| <span id="344">344</span> |
| <span id="345">345</span> |
| <span id="346">346</span> |
| <span id="347">347</span> |
| <span id="348">348</span> |
| <span id="349">349</span> |
| <span id="350">350</span> |
| <span id="351">351</span> |
| <span id="352">352</span> |
| <span id="353">353</span> |
| <span id="354">354</span> |
| <span id="355">355</span> |
| <span id="356">356</span> |
| <span id="357">357</span> |
| <span id="358">358</span> |
| <span id="359">359</span> |
| <span id="360">360</span> |
| <span id="361">361</span> |
| <span id="362">362</span> |
| <span id="363">363</span> |
| <span id="364">364</span> |
| <span id="365">365</span> |
| <span id="366">366</span> |
| <span id="367">367</span> |
| <span id="368">368</span> |
| <span id="369">369</span> |
| <span id="370">370</span> |
| <span id="371">371</span> |
| <span id="372">372</span> |
| <span id="373">373</span> |
| <span id="374">374</span> |
| <span id="375">375</span> |
| <span id="376">376</span> |
| <span id="377">377</span> |
| <span id="378">378</span> |
| <span id="379">379</span> |
| <span id="380">380</span> |
| <span id="381">381</span> |
| <span id="382">382</span> |
| <span id="383">383</span> |
| <span id="384">384</span> |
| <span id="385">385</span> |
| <span id="386">386</span> |
| <span id="387">387</span> |
| <span id="388">388</span> |
| <span id="389">389</span> |
| <span id="390">390</span> |
| <span id="391">391</span> |
| <span id="392">392</span> |
| <span id="393">393</span> |
| <span id="394">394</span> |
| <span id="395">395</span> |
| <span id="396">396</span> |
| <span id="397">397</span> |
| <span id="398">398</span> |
| <span id="399">399</span> |
| <span id="400">400</span> |
| <span id="401">401</span> |
| <span id="402">402</span> |
| <span id="403">403</span> |
| <span id="404">404</span> |
| <span id="405">405</span> |
| <span id="406">406</span> |
| <span id="407">407</span> |
| <span id="408">408</span> |
| <span id="409">409</span> |
| <span id="410">410</span> |
| <span id="411">411</span> |
| <span id="412">412</span> |
| <span id="413">413</span> |
| <span id="414">414</span> |
| <span id="415">415</span> |
| <span id="416">416</span> |
| <span id="417">417</span> |
| <span id="418">418</span> |
| <span id="419">419</span> |
| <span id="420">420</span> |
| <span id="421">421</span> |
| <span id="422">422</span> |
| <span id="423">423</span> |
| <span id="424">424</span> |
| <span id="425">425</span> |
| <span id="426">426</span> |
| <span id="427">427</span> |
| <span id="428">428</span> |
| <span id="429">429</span> |
| <span id="430">430</span> |
| <span id="431">431</span> |
| <span id="432">432</span> |
| <span id="433">433</span> |
| <span id="434">434</span> |
| <span id="435">435</span> |
| <span id="436">436</span> |
| <span id="437">437</span> |
| <span id="438">438</span> |
| <span id="439">439</span> |
| <span id="440">440</span> |
| <span id="441">441</span> |
| <span id="442">442</span> |
| <span id="443">443</span> |
| <span id="444">444</span> |
| <span id="445">445</span> |
| <span id="446">446</span> |
| <span id="447">447</span> |
| <span id="448">448</span> |
| <span id="449">449</span> |
| <span id="450">450</span> |
| <span id="451">451</span> |
| <span id="452">452</span> |
| <span id="453">453</span> |
| <span id="454">454</span> |
| <span id="455">455</span> |
| <span id="456">456</span> |
| <span id="457">457</span> |
| <span id="458">458</span> |
| <span id="459">459</span> |
| <span id="460">460</span> |
| <span id="461">461</span> |
| <span id="462">462</span> |
| <span id="463">463</span> |
| <span id="464">464</span> |
| <span id="465">465</span> |
| <span id="466">466</span> |
| <span id="467">467</span> |
| <span id="468">468</span> |
| <span id="469">469</span> |
| <span id="470">470</span> |
| <span id="471">471</span> |
| <span id="472">472</span> |
| <span id="473">473</span> |
| <span id="474">474</span> |
| <span id="475">475</span> |
| <span id="476">476</span> |
| <span id="477">477</span> |
| <span id="478">478</span> |
| <span id="479">479</span> |
| <span id="480">480</span> |
| <span id="481">481</span> |
| <span id="482">482</span> |
| <span id="483">483</span> |
| <span id="484">484</span> |
| <span id="485">485</span> |
| <span id="486">486</span> |
| <span id="487">487</span> |
| <span id="488">488</span> |
| <span id="489">489</span> |
| <span id="490">490</span> |
| <span id="491">491</span> |
| <span id="492">492</span> |
| <span id="493">493</span> |
| <span id="494">494</span> |
| <span id="495">495</span> |
| <span id="496">496</span> |
| <span id="497">497</span> |
| <span id="498">498</span> |
| <span id="499">499</span> |
| <span id="500">500</span> |
| <span id="501">501</span> |
| <span id="502">502</span> |
| <span id="503">503</span> |
| <span id="504">504</span> |
| <span id="505">505</span> |
| <span id="506">506</span> |
| <span id="507">507</span> |
| <span id="508">508</span> |
| <span id="509">509</span> |
| <span id="510">510</span> |
| <span id="511">511</span> |
| <span id="512">512</span> |
| <span id="513">513</span> |
| <span id="514">514</span> |
| <span id="515">515</span> |
| <span id="516">516</span> |
| <span id="517">517</span> |
| <span id="518">518</span> |
| <span id="519">519</span> |
| <span id="520">520</span> |
| <span id="521">521</span> |
| <span id="522">522</span> |
| <span id="523">523</span> |
| <span id="524">524</span> |
| <span id="525">525</span> |
| <span id="526">526</span> |
| <span id="527">527</span> |
| <span id="528">528</span> |
| <span id="529">529</span> |
| <span id="530">530</span> |
| <span id="531">531</span> |
| <span id="532">532</span> |
| <span id="533">533</span> |
| <span id="534">534</span> |
| </pre><pre class="rust"><code><span class="doccomment">//! Contains detailed error representation. |
| //! |
| //! See the main [`ImageError`] which contains a variant for each specialized error type. The |
| //! subtypes used in each variant are opaque by design. They can be roughly inspected through their |
| //! respective `kind` methods which work similar to `std::io::Error::kind`. |
| //! |
| //! The error interface makes it possible to inspect the error of an underlying decoder or encoder, |
| //! through the `Error::source` method. Note that this is not part of the stable interface and you |
| //! may not rely on a particular error value for a particular operation. This means mainly that |
| //! `image` does not promise to remain on a particular version of its underlying decoders but if |
| //! you ensure to use the same version of the dependency (or at least of the error type) through |
| //! external means then you could inspect the error type in slightly more detail. |
| //! |
| //! [`ImageError`]: enum.ImageError.html |
| |
| </span><span class="kw">use </span>std::{fmt, io}; |
| <span class="kw">use </span>std::error::Error; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::color::ExtendedColorType; |
| <span class="kw">use </span><span class="kw">crate</span>::image::ImageFormat; |
| <span class="kw">use </span><span class="kw">crate</span>::utils::NonExhaustiveMarker; |
| |
| <span class="doccomment">/// The generic error type for image operations. |
| /// |
| /// This high level enum allows, by variant matching, a rough separation of concerns between |
| /// underlying IO, the caller, format specifications, and the `image` implementation. |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub enum </span>ImageError { |
| <span class="doccomment">/// An error was encountered while decoding. |
| /// |
| /// This means that the input data did not conform to the specification of some image format, |
| /// or that no format could be determined, or that it did not match format specific |
| /// requirements set by the caller. |
| </span>Decoding(DecodingError), |
| |
| <span class="doccomment">/// An error was encountered while encoding. |
| /// |
| /// The input image can not be encoded with the chosen format, for example because the |
| /// specification has no representation for its color space or because a necessary conversion |
| /// is ambiguous. In some cases it might also happen that the dimensions can not be used with |
| /// the format. |
| </span>Encoding(EncodingError), |
| |
| <span class="doccomment">/// An error was encountered in input arguments. |
| /// |
| /// This is a catch-all case for strictly internal operations such as scaling, conversions, |
| /// etc. that involve no external format specifications. |
| </span>Parameter(ParameterError), |
| |
| <span class="doccomment">/// Completing the operation would have required more resources than allowed. |
| /// |
| /// Errors of this type are limits set by the user or environment, *not* inherent in a specific |
| /// format or operation that was executed. |
| </span>Limits(LimitError), |
| |
| <span class="doccomment">/// An operation can not be completed by the chosen abstraction. |
| /// |
| /// This means that it might be possible for the operation to succeed in general but |
| /// * it requires a disabled feature, |
| /// * the implementation does not yet exist, or |
| /// * no abstraction for a lower level could be found. |
| </span>Unsupported(UnsupportedError), |
| |
| <span class="doccomment">/// An error occurred while interacting with the environment. |
| </span>IoError(io::Error), |
| } |
| |
| <span class="doccomment">/// The implementation for an operation was not provided. |
| /// |
| /// See the variant [`Unsupported`] for more documentation. |
| /// |
| /// [`Unsupported`]: enum.ImageError.html#variant.Unsupported |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>UnsupportedError { |
| format: ImageFormatHint, |
| kind: UnsupportedErrorKind, |
| } |
| |
| <span class="doccomment">/// Details what feature is not supported. |
| </span><span class="attribute">#[derive(Clone, Debug, Hash, PartialEq)] |
| </span><span class="kw">pub enum </span>UnsupportedErrorKind { |
| <span class="doccomment">/// The required color type can not be handled. |
| </span>Color(ExtendedColorType), |
| <span class="doccomment">/// An image format is not supported. |
| </span>Format(ImageFormatHint), |
| <span class="doccomment">/// Some feature specified by string. |
| /// This is discouraged and is likely to get deprecated (but not removed). |
| </span>GenericFeature(String), |
| <span class="attribute">#[doc(hidden)] |
| </span>__NonExhaustive(NonExhaustiveMarker), |
| } |
| |
| <span class="doccomment">/// An error was encountered while encoding an image. |
| /// |
| /// This is used as an opaque representation for the [`ImageError::Encoding`] variant. See its |
| /// documentation for more information. |
| /// |
| /// [`ImageError::Encoding`]: enum.ImageError.html#variant.Encoding |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>EncodingError { |
| format: ImageFormatHint, |
| underlying: <span class="prelude-ty">Option</span><Box<<span class="kw">dyn </span>Error + Send + Sync>>, |
| } |
| |
| |
| <span class="doccomment">/// An error was encountered in inputs arguments. |
| /// |
| /// This is used as an opaque representation for the [`ImageError::Parameter`] variant. See its |
| /// documentation for more information. |
| /// |
| /// [`ImageError::Parameter`]: enum.ImageError.html#variant.Parameter |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>ParameterError { |
| kind: ParameterErrorKind, |
| underlying: <span class="prelude-ty">Option</span><Box<<span class="kw">dyn </span>Error + Send + Sync>>, |
| } |
| |
| <span class="doccomment">/// Details how a parameter is malformed. |
| </span><span class="attribute">#[derive(Clone, Debug, Hash, PartialEq)] |
| </span><span class="kw">pub enum </span>ParameterErrorKind { |
| <span class="doccomment">/// The dimensions passed are wrong. |
| </span>DimensionMismatch, |
| <span class="doccomment">/// Repeated an operation for which error that could not be cloned was emitted already. |
| </span>FailedAlready, |
| <span class="doccomment">/// A string describing the parameter. |
| /// This is discouraged and is likely to get deprecated (but not removed). |
| </span>Generic(String), |
| <span class="doccomment">/// The end of the image has been reached. |
| </span>NoMoreData, |
| <span class="attribute">#[doc(hidden)] |
| </span><span class="doccomment">/// Do not use this, not part of stability guarantees. |
| </span>__NonExhaustive(NonExhaustiveMarker), |
| } |
| |
| <span class="doccomment">/// An error was encountered while decoding an image. |
| /// |
| /// This is used as an opaque representation for the [`ImageError::Decoding`] variant. See its |
| /// documentation for more information. |
| /// |
| /// [`ImageError::Decoding`]: enum.ImageError.html#variant.Decoding |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>DecodingError { |
| format: ImageFormatHint, |
| underlying: <span class="prelude-ty">Option</span><Box<<span class="kw">dyn </span>Error + Send + Sync>>, |
| } |
| |
| <span class="doccomment">/// Completing the operation would have required more resources than allowed. |
| /// |
| /// This is used as an opaque representation for the [`ImageError::Limits`] variant. See its |
| /// documentation for more information. |
| /// |
| /// [`ImageError::Limits`]: enum.ImageError.html#variant.Limits |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>LimitError { |
| kind: LimitErrorKind, |
| <span class="comment">// do we need an underlying error? |
| </span>} |
| |
| <span class="doccomment">/// Indicates the limit that prevented an operation from completing. |
| /// |
| /// Note that this enumeration is not exhaustive and may in the future be extended to provide more |
| /// detailed information or to incorporate other resources types. |
| </span><span class="attribute">#[derive(Clone, Debug, Hash, PartialEq, Eq)] |
| #[allow(missing_copy_implementations)] </span><span class="comment">// Might be non-Copy in the future. |
| </span><span class="kw">pub enum </span>LimitErrorKind { |
| <span class="doccomment">/// The resulting image exceed dimension limits in either direction. |
| </span>DimensionError, |
| <span class="doccomment">/// The operation would have performed an allocation larger than allowed. |
| </span>InsufficientMemory, |
| <span class="attribute">#[doc(hidden)] |
| </span><span class="doccomment">/// Do not use this, not part of stability guarantees. |
| </span>__NonExhaustive(NonExhaustiveMarker), |
| } |
| |
| <span class="doccomment">/// A best effort representation for image formats. |
| </span><span class="attribute">#[derive(Clone, Debug, Hash, PartialEq)] |
| </span><span class="kw">pub enum </span>ImageFormatHint { |
| <span class="doccomment">/// The format is known exactly. |
| </span>Exact(ImageFormat), |
| |
| <span class="doccomment">/// The format can be identified by a name. |
| </span>Name(String), |
| |
| <span class="doccomment">/// A common path extension for the format is known. |
| </span>PathExtension(std::path::PathBuf), |
| |
| <span class="doccomment">/// The format is not known or could not be determined. |
| </span>Unknown, |
| |
| <span class="attribute">#[doc(hidden)] |
| </span>__NonExhaustive(NonExhaustiveMarker), |
| } |
| |
| <span class="kw">impl </span>UnsupportedError { |
| <span class="doccomment">/// Create an `UnsupportedError` for an image with details on the unsupported feature. |
| /// |
| /// If the operation was not connected to a particular image format then the hint may be |
| /// `Unknown`. |
| </span><span class="kw">pub fn </span>from_format_and_kind(format: ImageFormatHint, kind: UnsupportedErrorKind) -> <span class="self">Self </span>{ |
| UnsupportedError { |
| format, |
| kind, |
| } |
| } |
| |
| <span class="doccomment">/// Returns the corresponding `UnsupportedErrorKind` of the error. |
| </span><span class="kw">pub fn </span>kind(<span class="kw-2">&</span><span class="self">self</span>) -> UnsupportedErrorKind { |
| <span class="self">self</span>.kind.clone() |
| } |
| |
| <span class="doccomment">/// Returns the image format associated with this error. |
| </span><span class="kw">pub fn </span>format_hint(<span class="kw-2">&</span><span class="self">self</span>) -> ImageFormatHint { |
| <span class="self">self</span>.format.clone() |
| } |
| } |
| |
| <span class="kw">impl </span>DecodingError { |
| <span class="doccomment">/// Create a `DecodingError` that stems from an arbitrary error of an underlying decoder. |
| </span><span class="kw">pub fn </span>new( |
| format: ImageFormatHint, |
| err: <span class="kw">impl </span>Into<Box<<span class="kw">dyn </span>Error + Send + Sync>>, |
| ) -> <span class="self">Self </span>{ |
| DecodingError { |
| format, |
| underlying: <span class="prelude-val">Some</span>(err.into()), |
| } |
| } |
| |
| <span class="doccomment">/// Create a `DecodingError` for an image format. |
| /// |
| /// The error will not contain any further information but is very easy to create. |
| </span><span class="kw">pub fn </span>from_format_hint(format: ImageFormatHint) -> <span class="self">Self </span>{ |
| DecodingError { |
| format, |
| underlying: <span class="prelude-val">None</span>, |
| } |
| } |
| |
| <span class="doccomment">/// Returns the image format associated with this error. |
| </span><span class="kw">pub fn </span>format_hint(<span class="kw-2">&</span><span class="self">self</span>) -> ImageFormatHint { |
| <span class="self">self</span>.format.clone() |
| } |
| } |
| |
| <span class="kw">impl </span>EncodingError { |
| <span class="doccomment">/// Create an `EncodingError` that stems from an arbitrary error of an underlying encoder. |
| </span><span class="kw">pub fn </span>new( |
| format: ImageFormatHint, |
| err: <span class="kw">impl </span>Into<Box<<span class="kw">dyn </span>Error + Send + Sync>>, |
| ) -> <span class="self">Self </span>{ |
| EncodingError { |
| format, |
| underlying: <span class="prelude-val">Some</span>(err.into()), |
| } |
| } |
| |
| <span class="doccomment">/// Create an `EncodingError` for an image format. |
| /// |
| /// The error will not contain any further information but is very easy to create. |
| </span><span class="kw">pub fn </span>from_format_hint(format: ImageFormatHint) -> <span class="self">Self </span>{ |
| EncodingError { |
| format, |
| underlying: <span class="prelude-val">None</span>, |
| } |
| } |
| |
| <span class="doccomment">/// Return the image format associated with this error. |
| </span><span class="kw">pub fn </span>format_hint(<span class="kw-2">&</span><span class="self">self</span>) -> ImageFormatHint { |
| <span class="self">self</span>.format.clone() |
| } |
| } |
| |
| <span class="kw">impl </span>ParameterError { |
| <span class="doccomment">/// Construct a `ParameterError` directly from a corresponding kind. |
| </span><span class="kw">pub fn </span>from_kind(kind: ParameterErrorKind) -> <span class="self">Self </span>{ |
| ParameterError { |
| kind, |
| underlying: <span class="prelude-val">None</span>, |
| } |
| } |
| |
| <span class="doccomment">/// Returns the corresponding `ParameterErrorKind` of the error. |
| </span><span class="kw">pub fn </span>kind(<span class="kw-2">&</span><span class="self">self</span>) -> ParameterErrorKind { |
| <span class="self">self</span>.kind.clone() |
| } |
| } |
| |
| <span class="kw">impl </span>LimitError { |
| <span class="doccomment">/// Construct a generic `LimitError` directly from a corresponding kind. |
| </span><span class="kw">pub fn </span>from_kind(kind: LimitErrorKind) -> <span class="self">Self </span>{ |
| LimitError { |
| kind, |
| } |
| } |
| |
| <span class="doccomment">/// Returns the corresponding `LimitErrorKind` of the error. |
| </span><span class="kw">pub fn </span>kind(<span class="kw-2">&</span><span class="self">self</span>) -> LimitErrorKind { |
| <span class="self">self</span>.kind.clone() |
| } |
| } |
| |
| <span class="kw">impl </span>From<io::Error> <span class="kw">for </span>ImageError { |
| <span class="kw">fn </span>from(err: io::Error) -> ImageError { |
| ImageError::IoError(err) |
| } |
| } |
| |
| <span class="kw">impl </span>From<ImageFormat> <span class="kw">for </span>ImageFormatHint { |
| <span class="kw">fn </span>from(format: ImageFormat) -> <span class="self">Self </span>{ |
| ImageFormatHint::Exact(format) |
| } |
| } |
| |
| <span class="kw">impl </span>From<<span class="kw-2">&</span><span class="lifetime">'_ </span>std::path::Path> <span class="kw">for </span>ImageFormatHint { |
| <span class="kw">fn </span>from(path: <span class="kw-2">&</span><span class="lifetime">'_ </span>std::path::Path) -> <span class="self">Self </span>{ |
| <span class="kw">match </span>path.extension() { |
| <span class="prelude-val">Some</span>(ext) => ImageFormatHint::PathExtension(ext.into()), |
| <span class="prelude-val">None </span>=> ImageFormatHint::Unknown, |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>From<ImageFormatHint> <span class="kw">for </span>UnsupportedError { |
| <span class="kw">fn </span>from(hint: ImageFormatHint) -> <span class="self">Self </span>{ |
| UnsupportedError { |
| format: hint.clone(), |
| kind: UnsupportedErrorKind::Format(hint), |
| } |
| } |
| } |
| |
| <span class="doccomment">/// Result of an image decoding/encoding process |
| </span><span class="kw">pub type </span>ImageResult<T> = <span class="prelude-ty">Result</span><T, ImageError>; |
| |
| <span class="kw">impl </span>fmt::Display <span class="kw">for </span>ImageError { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, fmt: <span class="kw-2">&mut </span>fmt::Formatter) -> <span class="prelude-ty">Result</span><(), fmt::Error> { |
| <span class="kw">match </span><span class="self">self </span>{ |
| ImageError::IoError(err) => err.fmt(fmt), |
| ImageError::Decoding(err) => err.fmt(fmt), |
| ImageError::Encoding(err) => err.fmt(fmt), |
| ImageError::Parameter(err) => err.fmt(fmt), |
| ImageError::Limits(err) => err.fmt(fmt), |
| ImageError::Unsupported(err) => err.fmt(fmt), |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>Error <span class="kw">for </span>ImageError { |
| <span class="kw">fn </span>source(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>(<span class="kw">dyn </span>Error + <span class="lifetime">'static</span>)> { |
| <span class="kw">match </span><span class="self">self </span>{ |
| ImageError::IoError(err) => err.source(), |
| ImageError::Decoding(err) => err.source(), |
| ImageError::Encoding(err) => err.source(), |
| ImageError::Parameter(err) => err.source(), |
| ImageError::Limits(err) => err.source(), |
| ImageError::Unsupported(err) => err.source(), |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Display <span class="kw">for </span>UnsupportedError { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, fmt: <span class="kw-2">&mut </span>fmt::Formatter) -> <span class="prelude-ty">Result</span><(), fmt::Error> { |
| <span class="kw">match </span><span class="kw-2">&</span><span class="self">self</span>.kind { |
| UnsupportedErrorKind::Format(ImageFormatHint::Unknown) => <span class="macro">write!</span>( |
| fmt, |
| <span class="string">"The image format could not be determined"</span>, |
| ), |
| UnsupportedErrorKind::Format(format @ ImageFormatHint::PathExtension(<span class="kw">_</span>)) => <span class="macro">write!</span>( |
| fmt, |
| <span class="string">"The file extension {} was not recognized as an image format"</span>, |
| format, |
| ), |
| UnsupportedErrorKind::Format(format) => <span class="macro">write!</span>( |
| fmt, |
| <span class="string">"The image format {} is not supported"</span>, |
| format, |
| ), |
| UnsupportedErrorKind::Color(color) => <span class="macro">write!</span>( |
| fmt, |
| <span class="string">"The decoder for {} does not support the color type `{:?}`"</span>, |
| <span class="self">self</span>.format, |
| color, |
| ), |
| UnsupportedErrorKind::GenericFeature(message) => { |
| <span class="kw">match </span><span class="kw-2">&</span><span class="self">self</span>.format { |
| ImageFormatHint::Unknown => <span class="macro">write!</span>( |
| fmt, |
| <span class="string">"The decoder does not support the format feature {}"</span>, |
| message, |
| ), |
| other => <span class="macro">write!</span>( |
| fmt, |
| <span class="string">"The decoder for {} does not support the format features {}"</span>, |
| other, |
| message, |
| ), |
| } |
| }, |
| UnsupportedErrorKind::__NonExhaustive(marker) => <span class="kw">match </span>marker._private {}, |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>Error <span class="kw">for </span>UnsupportedError { } |
| |
| <span class="kw">impl </span>fmt::Display <span class="kw">for </span>ParameterError { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, fmt: <span class="kw-2">&mut </span>fmt::Formatter) -> <span class="prelude-ty">Result</span><(), fmt::Error> { |
| <span class="kw">match </span><span class="kw-2">&</span><span class="self">self</span>.kind { |
| ParameterErrorKind::DimensionMismatch => <span class="macro">write!</span>( |
| fmt, |
| <span class="string">"The Image's dimensions are either too \ |
| small or too large" |
| </span>), |
| ParameterErrorKind::FailedAlready => <span class="macro">write!</span>( |
| fmt, |
| <span class="string">"The end the image stream has been reached due to a previous error" |
| </span>), |
| ParameterErrorKind::Generic(message) => <span class="macro">write!</span>( |
| fmt, |
| <span class="string">"The parameter is malformed: {}"</span>, |
| message, |
| ), |
| ParameterErrorKind::NoMoreData => <span class="macro">write!</span>( |
| fmt, |
| <span class="string">"The end of the image has been reached"</span>, |
| ), |
| ParameterErrorKind::__NonExhaustive(marker) => <span class="kw">match </span>marker._private {}, |
| }<span class="question-mark">?</span>; |
| |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(underlying) = <span class="kw-2">&</span><span class="self">self</span>.underlying { |
| <span class="macro">write!</span>(fmt, <span class="string">"\n{}"</span>, underlying)<span class="question-mark">?</span>; |
| } |
| |
| <span class="prelude-val">Ok</span>(()) |
| } |
| } |
| |
| <span class="kw">impl </span>Error <span class="kw">for </span>ParameterError { |
| <span class="kw">fn </span>source(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>(<span class="kw">dyn </span>Error + <span class="lifetime">'static</span>)> { |
| <span class="kw">match </span><span class="kw-2">&</span><span class="self">self</span>.underlying { |
| <span class="prelude-val">None </span>=> <span class="prelude-val">None</span>, |
| <span class="prelude-val">Some</span>(source) => <span class="prelude-val">Some</span>(<span class="kw-2">&**</span>source), |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Display <span class="kw">for </span>EncodingError { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, fmt: <span class="kw-2">&mut </span>fmt::Formatter) -> <span class="prelude-ty">Result</span><(), fmt::Error> { |
| <span class="kw">match </span><span class="kw-2">&</span><span class="self">self</span>.underlying { |
| <span class="prelude-val">Some</span>(underlying) => <span class="macro">write!</span>( |
| fmt, |
| <span class="string">"Format error encoding {}:\n{}"</span>, |
| <span class="self">self</span>.format, |
| underlying, |
| ), |
| <span class="prelude-val">None </span>=> <span class="macro">write!</span>( |
| fmt, |
| <span class="string">"Format error encoding {}"</span>, |
| <span class="self">self</span>.format, |
| ), |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>Error <span class="kw">for </span>EncodingError { |
| <span class="kw">fn </span>source(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>(<span class="kw">dyn </span>Error + <span class="lifetime">'static</span>)> { |
| <span class="kw">match </span><span class="kw-2">&</span><span class="self">self</span>.underlying { |
| <span class="prelude-val">None </span>=> <span class="prelude-val">None</span>, |
| <span class="prelude-val">Some</span>(source) => <span class="prelude-val">Some</span>(<span class="kw-2">&**</span>source), |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Display <span class="kw">for </span>DecodingError { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, fmt: <span class="kw-2">&mut </span>fmt::Formatter) -> <span class="prelude-ty">Result</span><(), fmt::Error> { |
| <span class="kw">match </span><span class="kw-2">&</span><span class="self">self</span>.underlying { |
| <span class="prelude-val">None </span>=> <span class="kw">match </span><span class="self">self</span>.format { |
| ImageFormatHint::Unknown => <span class="macro">write!</span>(fmt, <span class="string">"Format error"</span>), |
| <span class="kw">_ </span>=> <span class="macro">write!</span>(fmt, <span class="string">"Format error decoding {}"</span>, <span class="self">self</span>.format), |
| }, |
| <span class="prelude-val">Some</span>(underlying) => <span class="macro">write!</span>(fmt, <span class="string">"Format error decoding {}: {}"</span>, <span class="self">self</span>.format, underlying), |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>Error <span class="kw">for </span>DecodingError { |
| <span class="kw">fn </span>source(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>(<span class="kw">dyn </span>Error + <span class="lifetime">'static</span>)> { |
| <span class="kw">match </span><span class="kw-2">&</span><span class="self">self</span>.underlying { |
| <span class="prelude-val">None </span>=> <span class="prelude-val">None</span>, |
| <span class="prelude-val">Some</span>(source) => <span class="prelude-val">Some</span>(<span class="kw-2">&**</span>source), |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Display <span class="kw">for </span>LimitError { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, fmt: <span class="kw-2">&mut </span>fmt::Formatter) -> <span class="prelude-ty">Result</span><(), fmt::Error> { |
| <span class="kw">match </span><span class="self">self</span>.kind { |
| LimitErrorKind::InsufficientMemory => <span class="macro">write!</span>(fmt, <span class="string">"Insufficient memory"</span>), |
| LimitErrorKind::DimensionError => <span class="macro">write!</span>(fmt, <span class="string">"Image is too large"</span>), |
| LimitErrorKind::__NonExhaustive(marker) => <span class="kw">match </span>marker._private {}, |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>Error <span class="kw">for </span>LimitError { } |
| |
| <span class="kw">impl </span>fmt::Display <span class="kw">for </span>ImageFormatHint { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, fmt: <span class="kw-2">&mut </span>fmt::Formatter) -> <span class="prelude-ty">Result</span><(), fmt::Error> { |
| <span class="kw">match </span><span class="self">self </span>{ |
| ImageFormatHint::Exact(format) => <span class="macro">write!</span>(fmt, <span class="string">"{:?}"</span>, format), |
| ImageFormatHint::Name(name) => <span class="macro">write!</span>(fmt, <span class="string">"`{}`"</span>, name), |
| ImageFormatHint::PathExtension(ext) => <span class="macro">write!</span>(fmt, <span class="string">"`.{:?}`"</span>, ext), |
| ImageFormatHint::Unknown => <span class="macro">write!</span>(fmt, <span class="string">"`Unknown`"</span>), |
| ImageFormatHint::__NonExhaustive(marker) => <span class="kw">match </span>marker._private {}, |
| } |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use </span>std::mem; |
| <span class="kw">use super</span>::<span class="kw-2">*</span>; |
| |
| <span class="attribute">#[allow(dead_code)] |
| </span><span class="comment">// This will fail to compile if the size of this type is large. |
| </span><span class="kw">const </span>ASSERT_SMALLISH: usize = [<span class="number">0</span>][(mem::size_of::<ImageError>() >= <span class="number">200</span>) <span class="kw">as </span>usize]; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_send_sync_stability() { |
| <span class="kw">fn </span>assert_send_sync<T: Send + Sync>() { } |
| |
| assert_send_sync::<ImageError>(); |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="image" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |