blob: d7db5ab3fba9367f271c249e820ca1360ff75e71 [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/git/checkouts/incubator-teaclave-crates-c8106113f74feefc/ede1f68/image/./src/image.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>image.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>
<span id="535">535</span>
<span id="536">536</span>
<span id="537">537</span>
<span id="538">538</span>
<span id="539">539</span>
<span id="540">540</span>
<span id="541">541</span>
<span id="542">542</span>
<span id="543">543</span>
<span id="544">544</span>
<span id="545">545</span>
<span id="546">546</span>
<span id="547">547</span>
<span id="548">548</span>
<span id="549">549</span>
<span id="550">550</span>
<span id="551">551</span>
<span id="552">552</span>
<span id="553">553</span>
<span id="554">554</span>
<span id="555">555</span>
<span id="556">556</span>
<span id="557">557</span>
<span id="558">558</span>
<span id="559">559</span>
<span id="560">560</span>
<span id="561">561</span>
<span id="562">562</span>
<span id="563">563</span>
<span id="564">564</span>
<span id="565">565</span>
<span id="566">566</span>
<span id="567">567</span>
<span id="568">568</span>
<span id="569">569</span>
<span id="570">570</span>
<span id="571">571</span>
<span id="572">572</span>
<span id="573">573</span>
<span id="574">574</span>
<span id="575">575</span>
<span id="576">576</span>
<span id="577">577</span>
<span id="578">578</span>
<span id="579">579</span>
<span id="580">580</span>
<span id="581">581</span>
<span id="582">582</span>
<span id="583">583</span>
<span id="584">584</span>
<span id="585">585</span>
<span id="586">586</span>
<span id="587">587</span>
<span id="588">588</span>
<span id="589">589</span>
<span id="590">590</span>
<span id="591">591</span>
<span id="592">592</span>
<span id="593">593</span>
<span id="594">594</span>
<span id="595">595</span>
<span id="596">596</span>
<span id="597">597</span>
<span id="598">598</span>
<span id="599">599</span>
<span id="600">600</span>
<span id="601">601</span>
<span id="602">602</span>
<span id="603">603</span>
<span id="604">604</span>
<span id="605">605</span>
<span id="606">606</span>
<span id="607">607</span>
<span id="608">608</span>
<span id="609">609</span>
<span id="610">610</span>
<span id="611">611</span>
<span id="612">612</span>
<span id="613">613</span>
<span id="614">614</span>
<span id="615">615</span>
<span id="616">616</span>
<span id="617">617</span>
<span id="618">618</span>
<span id="619">619</span>
<span id="620">620</span>
<span id="621">621</span>
<span id="622">622</span>
<span id="623">623</span>
<span id="624">624</span>
<span id="625">625</span>
<span id="626">626</span>
<span id="627">627</span>
<span id="628">628</span>
<span id="629">629</span>
<span id="630">630</span>
<span id="631">631</span>
<span id="632">632</span>
<span id="633">633</span>
<span id="634">634</span>
<span id="635">635</span>
<span id="636">636</span>
<span id="637">637</span>
<span id="638">638</span>
<span id="639">639</span>
<span id="640">640</span>
<span id="641">641</span>
<span id="642">642</span>
<span id="643">643</span>
<span id="644">644</span>
<span id="645">645</span>
<span id="646">646</span>
<span id="647">647</span>
<span id="648">648</span>
<span id="649">649</span>
<span id="650">650</span>
<span id="651">651</span>
<span id="652">652</span>
<span id="653">653</span>
<span id="654">654</span>
<span id="655">655</span>
<span id="656">656</span>
<span id="657">657</span>
<span id="658">658</span>
<span id="659">659</span>
<span id="660">660</span>
<span id="661">661</span>
<span id="662">662</span>
<span id="663">663</span>
<span id="664">664</span>
<span id="665">665</span>
<span id="666">666</span>
<span id="667">667</span>
<span id="668">668</span>
<span id="669">669</span>
<span id="670">670</span>
<span id="671">671</span>
<span id="672">672</span>
<span id="673">673</span>
<span id="674">674</span>
<span id="675">675</span>
<span id="676">676</span>
<span id="677">677</span>
<span id="678">678</span>
<span id="679">679</span>
<span id="680">680</span>
<span id="681">681</span>
<span id="682">682</span>
<span id="683">683</span>
<span id="684">684</span>
<span id="685">685</span>
<span id="686">686</span>
<span id="687">687</span>
<span id="688">688</span>
<span id="689">689</span>
<span id="690">690</span>
<span id="691">691</span>
<span id="692">692</span>
<span id="693">693</span>
<span id="694">694</span>
<span id="695">695</span>
<span id="696">696</span>
<span id="697">697</span>
<span id="698">698</span>
<span id="699">699</span>
<span id="700">700</span>
<span id="701">701</span>
<span id="702">702</span>
<span id="703">703</span>
<span id="704">704</span>
<span id="705">705</span>
<span id="706">706</span>
<span id="707">707</span>
<span id="708">708</span>
<span id="709">709</span>
<span id="710">710</span>
<span id="711">711</span>
<span id="712">712</span>
<span id="713">713</span>
<span id="714">714</span>
<span id="715">715</span>
<span id="716">716</span>
<span id="717">717</span>
<span id="718">718</span>
<span id="719">719</span>
<span id="720">720</span>
<span id="721">721</span>
<span id="722">722</span>
<span id="723">723</span>
<span id="724">724</span>
<span id="725">725</span>
<span id="726">726</span>
<span id="727">727</span>
<span id="728">728</span>
<span id="729">729</span>
<span id="730">730</span>
<span id="731">731</span>
<span id="732">732</span>
<span id="733">733</span>
<span id="734">734</span>
<span id="735">735</span>
<span id="736">736</span>
<span id="737">737</span>
<span id="738">738</span>
<span id="739">739</span>
<span id="740">740</span>
<span id="741">741</span>
<span id="742">742</span>
<span id="743">743</span>
<span id="744">744</span>
<span id="745">745</span>
<span id="746">746</span>
<span id="747">747</span>
<span id="748">748</span>
<span id="749">749</span>
<span id="750">750</span>
<span id="751">751</span>
<span id="752">752</span>
<span id="753">753</span>
<span id="754">754</span>
<span id="755">755</span>
<span id="756">756</span>
<span id="757">757</span>
<span id="758">758</span>
<span id="759">759</span>
<span id="760">760</span>
<span id="761">761</span>
<span id="762">762</span>
<span id="763">763</span>
<span id="764">764</span>
<span id="765">765</span>
<span id="766">766</span>
<span id="767">767</span>
<span id="768">768</span>
<span id="769">769</span>
<span id="770">770</span>
<span id="771">771</span>
<span id="772">772</span>
<span id="773">773</span>
<span id="774">774</span>
<span id="775">775</span>
<span id="776">776</span>
<span id="777">777</span>
<span id="778">778</span>
<span id="779">779</span>
<span id="780">780</span>
<span id="781">781</span>
<span id="782">782</span>
<span id="783">783</span>
<span id="784">784</span>
<span id="785">785</span>
<span id="786">786</span>
<span id="787">787</span>
<span id="788">788</span>
<span id="789">789</span>
<span id="790">790</span>
<span id="791">791</span>
<span id="792">792</span>
<span id="793">793</span>
<span id="794">794</span>
<span id="795">795</span>
<span id="796">796</span>
<span id="797">797</span>
<span id="798">798</span>
<span id="799">799</span>
<span id="800">800</span>
<span id="801">801</span>
<span id="802">802</span>
<span id="803">803</span>
<span id="804">804</span>
<span id="805">805</span>
<span id="806">806</span>
<span id="807">807</span>
<span id="808">808</span>
<span id="809">809</span>
<span id="810">810</span>
<span id="811">811</span>
<span id="812">812</span>
<span id="813">813</span>
<span id="814">814</span>
<span id="815">815</span>
<span id="816">816</span>
<span id="817">817</span>
<span id="818">818</span>
<span id="819">819</span>
<span id="820">820</span>
<span id="821">821</span>
<span id="822">822</span>
<span id="823">823</span>
<span id="824">824</span>
<span id="825">825</span>
<span id="826">826</span>
<span id="827">827</span>
<span id="828">828</span>
<span id="829">829</span>
<span id="830">830</span>
<span id="831">831</span>
<span id="832">832</span>
<span id="833">833</span>
<span id="834">834</span>
<span id="835">835</span>
<span id="836">836</span>
<span id="837">837</span>
<span id="838">838</span>
<span id="839">839</span>
<span id="840">840</span>
<span id="841">841</span>
<span id="842">842</span>
<span id="843">843</span>
<span id="844">844</span>
<span id="845">845</span>
<span id="846">846</span>
<span id="847">847</span>
<span id="848">848</span>
<span id="849">849</span>
<span id="850">850</span>
<span id="851">851</span>
<span id="852">852</span>
<span id="853">853</span>
<span id="854">854</span>
<span id="855">855</span>
<span id="856">856</span>
<span id="857">857</span>
<span id="858">858</span>
<span id="859">859</span>
<span id="860">860</span>
<span id="861">861</span>
<span id="862">862</span>
<span id="863">863</span>
<span id="864">864</span>
<span id="865">865</span>
<span id="866">866</span>
<span id="867">867</span>
<span id="868">868</span>
<span id="869">869</span>
<span id="870">870</span>
<span id="871">871</span>
<span id="872">872</span>
<span id="873">873</span>
<span id="874">874</span>
<span id="875">875</span>
<span id="876">876</span>
<span id="877">877</span>
<span id="878">878</span>
<span id="879">879</span>
<span id="880">880</span>
<span id="881">881</span>
<span id="882">882</span>
<span id="883">883</span>
<span id="884">884</span>
<span id="885">885</span>
<span id="886">886</span>
<span id="887">887</span>
<span id="888">888</span>
<span id="889">889</span>
<span id="890">890</span>
<span id="891">891</span>
<span id="892">892</span>
<span id="893">893</span>
<span id="894">894</span>
<span id="895">895</span>
<span id="896">896</span>
<span id="897">897</span>
<span id="898">898</span>
<span id="899">899</span>
<span id="900">900</span>
<span id="901">901</span>
<span id="902">902</span>
<span id="903">903</span>
<span id="904">904</span>
<span id="905">905</span>
<span id="906">906</span>
<span id="907">907</span>
<span id="908">908</span>
<span id="909">909</span>
<span id="910">910</span>
<span id="911">911</span>
<span id="912">912</span>
<span id="913">913</span>
<span id="914">914</span>
<span id="915">915</span>
<span id="916">916</span>
<span id="917">917</span>
<span id="918">918</span>
<span id="919">919</span>
<span id="920">920</span>
<span id="921">921</span>
<span id="922">922</span>
<span id="923">923</span>
<span id="924">924</span>
<span id="925">925</span>
<span id="926">926</span>
<span id="927">927</span>
<span id="928">928</span>
<span id="929">929</span>
<span id="930">930</span>
<span id="931">931</span>
<span id="932">932</span>
<span id="933">933</span>
<span id="934">934</span>
<span id="935">935</span>
<span id="936">936</span>
<span id="937">937</span>
<span id="938">938</span>
<span id="939">939</span>
<span id="940">940</span>
<span id="941">941</span>
<span id="942">942</span>
<span id="943">943</span>
<span id="944">944</span>
<span id="945">945</span>
<span id="946">946</span>
<span id="947">947</span>
<span id="948">948</span>
<span id="949">949</span>
<span id="950">950</span>
<span id="951">951</span>
<span id="952">952</span>
<span id="953">953</span>
<span id="954">954</span>
<span id="955">955</span>
<span id="956">956</span>
<span id="957">957</span>
<span id="958">958</span>
<span id="959">959</span>
<span id="960">960</span>
<span id="961">961</span>
<span id="962">962</span>
<span id="963">963</span>
<span id="964">964</span>
<span id="965">965</span>
<span id="966">966</span>
<span id="967">967</span>
<span id="968">968</span>
<span id="969">969</span>
<span id="970">970</span>
<span id="971">971</span>
<span id="972">972</span>
<span id="973">973</span>
<span id="974">974</span>
<span id="975">975</span>
<span id="976">976</span>
<span id="977">977</span>
<span id="978">978</span>
<span id="979">979</span>
<span id="980">980</span>
<span id="981">981</span>
<span id="982">982</span>
<span id="983">983</span>
<span id="984">984</span>
<span id="985">985</span>
<span id="986">986</span>
<span id="987">987</span>
<span id="988">988</span>
<span id="989">989</span>
<span id="990">990</span>
<span id="991">991</span>
<span id="992">992</span>
<span id="993">993</span>
<span id="994">994</span>
<span id="995">995</span>
<span id="996">996</span>
<span id="997">997</span>
<span id="998">998</span>
<span id="999">999</span>
<span id="1000">1000</span>
<span id="1001">1001</span>
<span id="1002">1002</span>
<span id="1003">1003</span>
<span id="1004">1004</span>
<span id="1005">1005</span>
<span id="1006">1006</span>
<span id="1007">1007</span>
<span id="1008">1008</span>
<span id="1009">1009</span>
<span id="1010">1010</span>
<span id="1011">1011</span>
<span id="1012">1012</span>
<span id="1013">1013</span>
<span id="1014">1014</span>
<span id="1015">1015</span>
<span id="1016">1016</span>
<span id="1017">1017</span>
<span id="1018">1018</span>
<span id="1019">1019</span>
<span id="1020">1020</span>
<span id="1021">1021</span>
<span id="1022">1022</span>
<span id="1023">1023</span>
<span id="1024">1024</span>
<span id="1025">1025</span>
<span id="1026">1026</span>
<span id="1027">1027</span>
<span id="1028">1028</span>
<span id="1029">1029</span>
<span id="1030">1030</span>
<span id="1031">1031</span>
<span id="1032">1032</span>
<span id="1033">1033</span>
<span id="1034">1034</span>
<span id="1035">1035</span>
<span id="1036">1036</span>
<span id="1037">1037</span>
<span id="1038">1038</span>
<span id="1039">1039</span>
<span id="1040">1040</span>
<span id="1041">1041</span>
<span id="1042">1042</span>
<span id="1043">1043</span>
<span id="1044">1044</span>
<span id="1045">1045</span>
<span id="1046">1046</span>
<span id="1047">1047</span>
<span id="1048">1048</span>
<span id="1049">1049</span>
<span id="1050">1050</span>
<span id="1051">1051</span>
<span id="1052">1052</span>
<span id="1053">1053</span>
<span id="1054">1054</span>
<span id="1055">1055</span>
<span id="1056">1056</span>
<span id="1057">1057</span>
<span id="1058">1058</span>
<span id="1059">1059</span>
<span id="1060">1060</span>
<span id="1061">1061</span>
<span id="1062">1062</span>
<span id="1063">1063</span>
<span id="1064">1064</span>
<span id="1065">1065</span>
<span id="1066">1066</span>
<span id="1067">1067</span>
<span id="1068">1068</span>
<span id="1069">1069</span>
<span id="1070">1070</span>
<span id="1071">1071</span>
<span id="1072">1072</span>
<span id="1073">1073</span>
<span id="1074">1074</span>
<span id="1075">1075</span>
<span id="1076">1076</span>
<span id="1077">1077</span>
<span id="1078">1078</span>
<span id="1079">1079</span>
<span id="1080">1080</span>
<span id="1081">1081</span>
<span id="1082">1082</span>
<span id="1083">1083</span>
<span id="1084">1084</span>
<span id="1085">1085</span>
<span id="1086">1086</span>
<span id="1087">1087</span>
<span id="1088">1088</span>
<span id="1089">1089</span>
<span id="1090">1090</span>
<span id="1091">1091</span>
<span id="1092">1092</span>
<span id="1093">1093</span>
<span id="1094">1094</span>
<span id="1095">1095</span>
<span id="1096">1096</span>
<span id="1097">1097</span>
<span id="1098">1098</span>
<span id="1099">1099</span>
<span id="1100">1100</span>
<span id="1101">1101</span>
<span id="1102">1102</span>
<span id="1103">1103</span>
<span id="1104">1104</span>
<span id="1105">1105</span>
<span id="1106">1106</span>
<span id="1107">1107</span>
<span id="1108">1108</span>
<span id="1109">1109</span>
<span id="1110">1110</span>
<span id="1111">1111</span>
<span id="1112">1112</span>
<span id="1113">1113</span>
<span id="1114">1114</span>
<span id="1115">1115</span>
<span id="1116">1116</span>
<span id="1117">1117</span>
<span id="1118">1118</span>
<span id="1119">1119</span>
<span id="1120">1120</span>
<span id="1121">1121</span>
<span id="1122">1122</span>
<span id="1123">1123</span>
<span id="1124">1124</span>
<span id="1125">1125</span>
<span id="1126">1126</span>
<span id="1127">1127</span>
<span id="1128">1128</span>
<span id="1129">1129</span>
<span id="1130">1130</span>
<span id="1131">1131</span>
<span id="1132">1132</span>
<span id="1133">1133</span>
<span id="1134">1134</span>
<span id="1135">1135</span>
<span id="1136">1136</span>
<span id="1137">1137</span>
<span id="1138">1138</span>
<span id="1139">1139</span>
<span id="1140">1140</span>
<span id="1141">1141</span>
<span id="1142">1142</span>
<span id="1143">1143</span>
<span id="1144">1144</span>
<span id="1145">1145</span>
<span id="1146">1146</span>
<span id="1147">1147</span>
<span id="1148">1148</span>
<span id="1149">1149</span>
<span id="1150">1150</span>
<span id="1151">1151</span>
<span id="1152">1152</span>
<span id="1153">1153</span>
<span id="1154">1154</span>
<span id="1155">1155</span>
<span id="1156">1156</span>
<span id="1157">1157</span>
<span id="1158">1158</span>
<span id="1159">1159</span>
<span id="1160">1160</span>
<span id="1161">1161</span>
<span id="1162">1162</span>
<span id="1163">1163</span>
<span id="1164">1164</span>
<span id="1165">1165</span>
<span id="1166">1166</span>
<span id="1167">1167</span>
<span id="1168">1168</span>
<span id="1169">1169</span>
<span id="1170">1170</span>
<span id="1171">1171</span>
<span id="1172">1172</span>
<span id="1173">1173</span>
<span id="1174">1174</span>
<span id="1175">1175</span>
<span id="1176">1176</span>
<span id="1177">1177</span>
<span id="1178">1178</span>
<span id="1179">1179</span>
<span id="1180">1180</span>
<span id="1181">1181</span>
<span id="1182">1182</span>
<span id="1183">1183</span>
<span id="1184">1184</span>
<span id="1185">1185</span>
<span id="1186">1186</span>
<span id="1187">1187</span>
<span id="1188">1188</span>
<span id="1189">1189</span>
<span id="1190">1190</span>
<span id="1191">1191</span>
<span id="1192">1192</span>
<span id="1193">1193</span>
<span id="1194">1194</span>
<span id="1195">1195</span>
<span id="1196">1196</span>
<span id="1197">1197</span>
<span id="1198">1198</span>
<span id="1199">1199</span>
<span id="1200">1200</span>
<span id="1201">1201</span>
<span id="1202">1202</span>
<span id="1203">1203</span>
<span id="1204">1204</span>
<span id="1205">1205</span>
<span id="1206">1206</span>
<span id="1207">1207</span>
<span id="1208">1208</span>
<span id="1209">1209</span>
<span id="1210">1210</span>
<span id="1211">1211</span>
<span id="1212">1212</span>
<span id="1213">1213</span>
<span id="1214">1214</span>
<span id="1215">1215</span>
<span id="1216">1216</span>
<span id="1217">1217</span>
<span id="1218">1218</span>
<span id="1219">1219</span>
<span id="1220">1220</span>
<span id="1221">1221</span>
<span id="1222">1222</span>
<span id="1223">1223</span>
<span id="1224">1224</span>
<span id="1225">1225</span>
<span id="1226">1226</span>
<span id="1227">1227</span>
<span id="1228">1228</span>
<span id="1229">1229</span>
<span id="1230">1230</span>
<span id="1231">1231</span>
<span id="1232">1232</span>
<span id="1233">1233</span>
<span id="1234">1234</span>
<span id="1235">1235</span>
<span id="1236">1236</span>
<span id="1237">1237</span>
<span id="1238">1238</span>
<span id="1239">1239</span>
<span id="1240">1240</span>
<span id="1241">1241</span>
<span id="1242">1242</span>
<span id="1243">1243</span>
<span id="1244">1244</span>
<span id="1245">1245</span>
<span id="1246">1246</span>
<span id="1247">1247</span>
<span id="1248">1248</span>
<span id="1249">1249</span>
<span id="1250">1250</span>
<span id="1251">1251</span>
<span id="1252">1252</span>
<span id="1253">1253</span>
<span id="1254">1254</span>
<span id="1255">1255</span>
<span id="1256">1256</span>
<span id="1257">1257</span>
<span id="1258">1258</span>
<span id="1259">1259</span>
<span id="1260">1260</span>
<span id="1261">1261</span>
<span id="1262">1262</span>
<span id="1263">1263</span>
<span id="1264">1264</span>
<span id="1265">1265</span>
<span id="1266">1266</span>
<span id="1267">1267</span>
<span id="1268">1268</span>
<span id="1269">1269</span>
<span id="1270">1270</span>
<span id="1271">1271</span>
<span id="1272">1272</span>
<span id="1273">1273</span>
<span id="1274">1274</span>
<span id="1275">1275</span>
<span id="1276">1276</span>
<span id="1277">1277</span>
<span id="1278">1278</span>
<span id="1279">1279</span>
<span id="1280">1280</span>
<span id="1281">1281</span>
<span id="1282">1282</span>
<span id="1283">1283</span>
<span id="1284">1284</span>
<span id="1285">1285</span>
<span id="1286">1286</span>
<span id="1287">1287</span>
<span id="1288">1288</span>
<span id="1289">1289</span>
<span id="1290">1290</span>
<span id="1291">1291</span>
<span id="1292">1292</span>
<span id="1293">1293</span>
<span id="1294">1294</span>
<span id="1295">1295</span>
<span id="1296">1296</span>
<span id="1297">1297</span>
<span id="1298">1298</span>
<span id="1299">1299</span>
<span id="1300">1300</span>
<span id="1301">1301</span>
<span id="1302">1302</span>
<span id="1303">1303</span>
<span id="1304">1304</span>
<span id="1305">1305</span>
<span id="1306">1306</span>
<span id="1307">1307</span>
<span id="1308">1308</span>
<span id="1309">1309</span>
<span id="1310">1310</span>
<span id="1311">1311</span>
<span id="1312">1312</span>
<span id="1313">1313</span>
<span id="1314">1314</span>
<span id="1315">1315</span>
<span id="1316">1316</span>
<span id="1317">1317</span>
<span id="1318">1318</span>
<span id="1319">1319</span>
<span id="1320">1320</span>
<span id="1321">1321</span>
<span id="1322">1322</span>
<span id="1323">1323</span>
<span id="1324">1324</span>
<span id="1325">1325</span>
<span id="1326">1326</span>
<span id="1327">1327</span>
<span id="1328">1328</span>
<span id="1329">1329</span>
<span id="1330">1330</span>
<span id="1331">1331</span>
<span id="1332">1332</span>
<span id="1333">1333</span>
<span id="1334">1334</span>
<span id="1335">1335</span>
<span id="1336">1336</span>
<span id="1337">1337</span>
<span id="1338">1338</span>
<span id="1339">1339</span>
<span id="1340">1340</span>
<span id="1341">1341</span>
<span id="1342">1342</span>
<span id="1343">1343</span>
<span id="1344">1344</span>
<span id="1345">1345</span>
<span id="1346">1346</span>
<span id="1347">1347</span>
<span id="1348">1348</span>
<span id="1349">1349</span>
<span id="1350">1350</span>
<span id="1351">1351</span>
<span id="1352">1352</span>
<span id="1353">1353</span>
<span id="1354">1354</span>
<span id="1355">1355</span>
<span id="1356">1356</span>
<span id="1357">1357</span>
<span id="1358">1358</span>
<span id="1359">1359</span>
<span id="1360">1360</span>
<span id="1361">1361</span>
<span id="1362">1362</span>
<span id="1363">1363</span>
<span id="1364">1364</span>
<span id="1365">1365</span>
<span id="1366">1366</span>
<span id="1367">1367</span>
<span id="1368">1368</span>
<span id="1369">1369</span>
<span id="1370">1370</span>
<span id="1371">1371</span>
<span id="1372">1372</span>
<span id="1373">1373</span>
<span id="1374">1374</span>
<span id="1375">1375</span>
<span id="1376">1376</span>
<span id="1377">1377</span>
<span id="1378">1378</span>
<span id="1379">1379</span>
<span id="1380">1380</span>
<span id="1381">1381</span>
</pre><pre class="rust"><code><span class="attribute">#![allow(clippy::too_many_arguments)]
</span><span class="kw">use </span>std::convert::TryFrom;
<span class="kw">use </span>std::ffi::OsStr;
<span class="kw">use </span>std::io;
<span class="kw">use </span>std::io::Read;
<span class="kw">use </span>std::ops::{Deref, DerefMut};
<span class="kw">use </span>std::path::Path;
<span class="kw">use </span>std::usize;
<span class="kw">use </span><span class="kw">crate</span>::ImageBuffer;
<span class="kw">use </span><span class="kw">crate</span>::color::{ColorType, ExtendedColorType};
<span class="kw">use </span><span class="kw">crate</span>::error::{ImageError, ImageFormatHint, ImageResult, LimitError, LimitErrorKind, ParameterError, ParameterErrorKind};
<span class="kw">use </span><span class="kw">crate</span>::math::Rect;
<span class="kw">use </span><span class="kw">crate</span>::traits::Pixel;
<span class="kw">use </span><span class="kw">crate</span>::animation::Frames;
<span class="attribute">#[cfg(feature = <span class="string">&quot;pnm&quot;</span>)]
</span><span class="kw">use </span><span class="kw">crate</span>::pnm::PNMSubtype;
<span class="doccomment">/// An enumeration of supported image formats.
/// Not all formats support both encoding and decoding.
</span><span class="attribute">#[derive(Clone, Copy, PartialEq, Eq, Debug, Hash)]
</span><span class="kw">pub enum </span>ImageFormat {
<span class="doccomment">/// An Image in PNG Format
</span>Png,
<span class="doccomment">/// An Image in JPEG Format
</span>Jpeg,
<span class="doccomment">/// An Image in GIF Format
</span>Gif,
<span class="doccomment">/// An Image in WEBP Format
</span>WebP,
<span class="doccomment">/// An Image in general PNM Format
</span>Pnm,
<span class="doccomment">/// An Image in TIFF Format
</span>Tiff,
<span class="doccomment">/// An Image in TGA Format
</span>Tga,
<span class="doccomment">/// An Image in DDS Format
</span>Dds,
<span class="doccomment">/// An Image in BMP Format
</span>Bmp,
<span class="doccomment">/// An Image in ICO Format
</span>Ico,
<span class="doccomment">/// An Image in Radiance HDR Format
</span>Hdr,
<span class="doccomment">/// An Image in farbfeld Format
</span>Farbfeld,
<span class="doccomment">/// An Image in AVIF format.
</span>Avif,
<span class="attribute">#[doc(hidden)]
</span>__NonExhaustive(<span class="kw">crate</span>::utils::NonExhaustiveMarker),
}
<span class="kw">impl </span>ImageFormat {
<span class="doccomment">/// Return the image format specified by a path&#39;s file extension.
///
/// # Example
///
/// ```
/// use image::ImageFormat;
///
/// let format = ImageFormat::from_extension(&quot;jpg&quot;);
/// assert_eq!(format, Some(ImageFormat::Jpeg));
/// ```
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>from_extension&lt;S&gt;(ext: S) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="self">Self</span>&gt; <span class="kw">where </span>S: AsRef&lt;OsStr&gt; {
<span class="comment">// thin wrapper function to strip generics
</span><span class="kw">fn </span>inner(ext: <span class="kw-2">&amp;</span>OsStr) -&gt; <span class="prelude-ty">Option</span>&lt;ImageFormat&gt; {
<span class="kw">let </span>ext = ext.to_str()<span class="question-mark">?</span>.to_ascii_lowercase();
<span class="prelude-val">Some</span>(<span class="kw">match </span>ext.as_str() {
<span class="string">&quot;avif&quot; </span>=&gt; ImageFormat::Avif,
<span class="string">&quot;jpg&quot; </span>| <span class="string">&quot;jpeg&quot; </span>=&gt; ImageFormat::Jpeg,
<span class="string">&quot;png&quot; </span>=&gt; ImageFormat::Png,
<span class="string">&quot;gif&quot; </span>=&gt; ImageFormat::Gif,
<span class="string">&quot;webp&quot; </span>=&gt; ImageFormat::WebP,
<span class="string">&quot;tif&quot; </span>| <span class="string">&quot;tiff&quot; </span>=&gt; ImageFormat::Tiff,
<span class="string">&quot;tga&quot; </span>=&gt; ImageFormat::Tga,
<span class="string">&quot;dds&quot; </span>=&gt; ImageFormat::Dds,
<span class="string">&quot;bmp&quot; </span>=&gt; ImageFormat::Bmp,
<span class="string">&quot;ico&quot; </span>=&gt; ImageFormat::Ico,
<span class="string">&quot;hdr&quot; </span>=&gt; ImageFormat::Hdr,
<span class="string">&quot;pbm&quot; </span>| <span class="string">&quot;pam&quot; </span>| <span class="string">&quot;ppm&quot; </span>| <span class="string">&quot;pgm&quot; </span>=&gt; ImageFormat::Pnm,
<span class="string">&quot;ff&quot; </span>| <span class="string">&quot;farbfeld&quot; </span>=&gt; ImageFormat::Farbfeld,
<span class="kw">_ </span>=&gt; <span class="kw">return </span><span class="prelude-val">None</span>,
})
}
inner(ext.as_ref())
}
<span class="doccomment">/// Return the image format specified by the path&#39;s file extension.
///
/// # Example
///
/// ```
/// use image::ImageFormat;
///
/// let format = ImageFormat::from_path(&quot;images/ferris.png&quot;)?;
/// assert_eq!(format, ImageFormat::Png);
///
/// # Ok::&lt;(), image::error::ImageError&gt;(())
/// ```
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>from_path&lt;P&gt;(path: P) -&gt; ImageResult&lt;<span class="self">Self</span>&gt; <span class="kw">where </span>P : AsRef&lt;Path&gt; {
<span class="comment">// thin wrapper function to strip generics
</span><span class="kw">fn </span>inner(path: <span class="kw-2">&amp;</span>Path) -&gt; ImageResult&lt;ImageFormat&gt; {
<span class="kw">let </span>exact_ext = path.extension();
exact_ext
.and_then(ImageFormat::from_extension)
.ok_or_else(|| {
<span class="kw">let </span>format_hint = <span class="kw">match </span>exact_ext {
<span class="prelude-val">None </span>=&gt; ImageFormatHint::Unknown,
<span class="prelude-val">Some</span>(os) =&gt; ImageFormatHint::PathExtension(os.into()),
};
ImageError::Unsupported(format_hint.into())
})
}
inner(path.as_ref())
}
<span class="doccomment">/// Return if the ImageFormat can be decoded by the lib.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>can_read(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="comment">// Needs to be updated once a new variant&#39;s decoder is added to free_functions.rs::load
</span><span class="kw">match </span><span class="self">self </span>{
ImageFormat::Png =&gt; <span class="bool-val">true</span>,
ImageFormat::Gif =&gt; <span class="bool-val">true</span>,
ImageFormat::Jpeg =&gt; <span class="bool-val">true</span>,
ImageFormat::WebP =&gt; <span class="bool-val">true</span>,
ImageFormat::Tiff =&gt; <span class="bool-val">true</span>,
ImageFormat::Tga =&gt; <span class="bool-val">true</span>,
ImageFormat::Dds =&gt; <span class="bool-val">false</span>,
ImageFormat::Bmp =&gt; <span class="bool-val">true</span>,
ImageFormat::Ico =&gt; <span class="bool-val">true</span>,
ImageFormat::Hdr =&gt; <span class="bool-val">true</span>,
ImageFormat::Pnm =&gt; <span class="bool-val">true</span>,
ImageFormat::Farbfeld =&gt; <span class="bool-val">true</span>,
ImageFormat::Avif =&gt; <span class="bool-val">true</span>,
ImageFormat::__NonExhaustive(marker) =&gt; <span class="kw">match </span>marker._private {},
}
}
<span class="doccomment">/// Return if the ImageFormat can be encoded by the lib.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>can_write(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="comment">// Needs to be updated once a new variant&#39;s encoder is added to free_functions.rs::save_buffer_with_format_impl
</span><span class="kw">match </span><span class="self">self </span>{
ImageFormat::Gif =&gt; <span class="bool-val">true</span>,
ImageFormat::Ico =&gt; <span class="bool-val">true</span>,
ImageFormat::Jpeg =&gt; <span class="bool-val">true</span>,
ImageFormat::Png =&gt; <span class="bool-val">true</span>,
ImageFormat::Bmp =&gt; <span class="bool-val">true</span>,
ImageFormat::Tiff =&gt; <span class="bool-val">true</span>,
ImageFormat::Tga =&gt; <span class="bool-val">true</span>,
ImageFormat::Pnm =&gt; <span class="bool-val">true</span>,
ImageFormat::Farbfeld =&gt; <span class="bool-val">true</span>,
ImageFormat::Avif =&gt; <span class="bool-val">true</span>,
ImageFormat::WebP =&gt; <span class="bool-val">false</span>,
ImageFormat::Hdr =&gt; <span class="bool-val">false</span>,
ImageFormat::Dds =&gt; <span class="bool-val">false</span>,
ImageFormat::__NonExhaustive(marker) =&gt; <span class="kw">match </span>marker._private {},
}
}
<span class="doccomment">/// Return a list of applicable extensions for this format.
///
/// All currently recognized image formats specify at least on extension but for future
/// compatibility you should not rely on this fact. The list may be empty if the format has no
/// recognized file representation, for example in case it is used as a purely transient memory
/// format.
///
/// The method name `extensions` remains reserved for introducing another method in the future
/// that yields a slice of `OsStr` which is blocked by several features of const evaluation.
</span><span class="kw">pub fn </span>extensions_str(<span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>[<span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>str] {
<span class="kw">match </span><span class="self">self </span>{
ImageFormat::Png =&gt; <span class="kw-2">&amp;</span>[<span class="string">&quot;png&quot;</span>],
ImageFormat::Jpeg =&gt; <span class="kw-2">&amp;</span>[<span class="string">&quot;jpg&quot;</span>, <span class="string">&quot;jpeg&quot;</span>],
ImageFormat::Gif =&gt; <span class="kw-2">&amp;</span>[<span class="string">&quot;gif&quot;</span>],
ImageFormat::WebP =&gt; <span class="kw-2">&amp;</span>[<span class="string">&quot;webp&quot;</span>],
ImageFormat::Pnm =&gt; <span class="kw-2">&amp;</span>[<span class="string">&quot;pbm&quot;</span>, <span class="string">&quot;pam&quot;</span>, <span class="string">&quot;ppm&quot;</span>, <span class="string">&quot;pgm&quot;</span>],
ImageFormat::Tiff =&gt; <span class="kw-2">&amp;</span>[<span class="string">&quot;tiff&quot;</span>, <span class="string">&quot;tif&quot;</span>],
ImageFormat::Tga =&gt; <span class="kw-2">&amp;</span>[<span class="string">&quot;tga&quot;</span>],
ImageFormat::Dds =&gt; <span class="kw-2">&amp;</span>[<span class="string">&quot;dds&quot;</span>],
ImageFormat::Bmp =&gt; <span class="kw-2">&amp;</span>[<span class="string">&quot;bmp&quot;</span>],
ImageFormat::Ico =&gt; <span class="kw-2">&amp;</span>[<span class="string">&quot;ico&quot;</span>],
ImageFormat::Hdr =&gt; <span class="kw-2">&amp;</span>[<span class="string">&quot;hdr&quot;</span>],
ImageFormat::Farbfeld =&gt; <span class="kw-2">&amp;</span>[<span class="string">&quot;ff&quot;</span>],
<span class="comment">// According to: https://aomediacodec.github.io/av1-avif/#mime-registration
</span>ImageFormat::Avif =&gt; <span class="kw-2">&amp;</span>[<span class="string">&quot;avif&quot;</span>],
ImageFormat::__NonExhaustive(marker) =&gt; <span class="kw">match </span>marker._private {},
}
}
}
<span class="doccomment">/// An enumeration of supported image formats for encoding.
</span><span class="attribute">#[derive(Clone, PartialEq, Eq, Debug)]
</span><span class="kw">pub enum </span>ImageOutputFormat {
<span class="attribute">#[cfg(feature = <span class="string">&quot;png&quot;</span>)]
</span><span class="doccomment">/// An Image in PNG Format
</span>Png,
<span class="attribute">#[cfg(feature = <span class="string">&quot;jpeg&quot;</span>)]
</span><span class="doccomment">/// An Image in JPEG Format with specified quality
</span>Jpeg(u8),
<span class="attribute">#[cfg(feature = <span class="string">&quot;pnm&quot;</span>)]
</span><span class="doccomment">/// An Image in one of the PNM Formats
</span>Pnm(PNMSubtype),
<span class="attribute">#[cfg(feature = <span class="string">&quot;gif&quot;</span>)]
</span><span class="doccomment">/// An Image in GIF Format
</span>Gif,
<span class="attribute">#[cfg(feature = <span class="string">&quot;ico&quot;</span>)]
</span><span class="doccomment">/// An Image in ICO Format
</span>Ico,
<span class="attribute">#[cfg(feature = <span class="string">&quot;bmp&quot;</span>)]
</span><span class="doccomment">/// An Image in BMP Format
</span>Bmp,
<span class="attribute">#[cfg(feature = <span class="string">&quot;farbfeld&quot;</span>)]
</span><span class="doccomment">/// An Image in farbfeld Format
</span>Farbfeld,
<span class="attribute">#[cfg(feature = <span class="string">&quot;tga&quot;</span>)]
</span><span class="doccomment">/// An Image in TGA Format
</span>Tga,
<span class="attribute">#[cfg(feature = <span class="string">&quot;avif&quot;</span>)]
</span><span class="doccomment">/// An image in AVIF Format
</span>Avif,
<span class="doccomment">/// A value for signalling an error: An unsupported format was requested
</span><span class="comment">// Note: When TryFrom is stabilized, this value should not be needed, and
// a TryInto&lt;ImageOutputFormat&gt; should be used instead of an Into&lt;ImageOutputFormat&gt;.
</span>Unsupported(String),
<span class="attribute">#[doc(hidden)]
</span>__NonExhaustive(<span class="kw">crate</span>::utils::NonExhaustiveMarker),
}
<span class="kw">impl </span>From&lt;ImageFormat&gt; <span class="kw">for </span>ImageOutputFormat {
<span class="kw">fn </span>from(fmt: ImageFormat) -&gt; <span class="self">Self </span>{
<span class="kw">match </span>fmt {
<span class="attribute">#[cfg(feature = <span class="string">&quot;png&quot;</span>)]
</span>ImageFormat::Png =&gt; ImageOutputFormat::Png,
<span class="attribute">#[cfg(feature = <span class="string">&quot;jpeg&quot;</span>)]
</span>ImageFormat::Jpeg =&gt; ImageOutputFormat::Jpeg(<span class="number">75</span>),
<span class="attribute">#[cfg(feature = <span class="string">&quot;pnm&quot;</span>)]
</span>ImageFormat::Pnm =&gt; ImageOutputFormat::Pnm(PNMSubtype::ArbitraryMap),
<span class="attribute">#[cfg(feature = <span class="string">&quot;gif&quot;</span>)]
</span>ImageFormat::Gif =&gt; ImageOutputFormat::Gif,
<span class="attribute">#[cfg(feature = <span class="string">&quot;ico&quot;</span>)]
</span>ImageFormat::Ico =&gt; ImageOutputFormat::Ico,
<span class="attribute">#[cfg(feature = <span class="string">&quot;bmp&quot;</span>)]
</span>ImageFormat::Bmp =&gt; ImageOutputFormat::Bmp,
<span class="attribute">#[cfg(feature = <span class="string">&quot;farbfeld&quot;</span>)]
</span>ImageFormat::Farbfeld =&gt; ImageOutputFormat::Farbfeld,
<span class="attribute">#[cfg(feature = <span class="string">&quot;tga&quot;</span>)]
</span>ImageFormat::Tga =&gt; ImageOutputFormat::Tga,
<span class="attribute">#[cfg(feature = <span class="string">&quot;avif&quot;</span>)]
</span>ImageFormat::Avif =&gt; ImageOutputFormat::Avif,
f =&gt; ImageOutputFormat::Unsupported(<span class="macro">format!</span>(<span class="string">&quot;{:?}&quot;</span>, f)),
}
}
}
<span class="comment">// This struct manages buffering associated with implementing `Read` and `Seek` on decoders that can
// must decode ranges of bytes at a time.
</span><span class="attribute">#[allow(dead_code)]
</span><span class="comment">// When no image formats that use it are enabled
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>ImageReadBuffer {
scanline_bytes: usize,
buffer: Vec&lt;u8&gt;,
consumed: usize,
total_bytes: u64,
offset: u64,
}
<span class="kw">impl </span>ImageReadBuffer {
<span class="doccomment">/// Create a new ImageReadBuffer.
///
/// Panics if scanline_bytes doesn&#39;t fit into a usize, because that would mean reading anything
/// from the image would take more RAM than the entire virtual address space. In other words,
/// actually using this struct would instantly OOM so just get it out of the way now.
</span><span class="attribute">#[allow(dead_code)]
</span><span class="comment">// When no image formats that use it are enabled
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new(scanline_bytes: u64, total_bytes: u64) -&gt; <span class="self">Self </span>{
<span class="self">Self </span>{
scanline_bytes: usize::try_from(scanline_bytes).unwrap(),
buffer: Vec::new(),
consumed: <span class="number">0</span>,
total_bytes,
offset: <span class="number">0</span>,
}
}
<span class="attribute">#[allow(dead_code)]
</span><span class="comment">// When no image formats that use it are enabled
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>read&lt;F&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, buf: <span class="kw-2">&amp;mut </span>[u8], <span class="kw-2">mut </span>read_scanline: F) -&gt; io::Result&lt;usize&gt;
<span class="kw">where
</span>F: FnMut(<span class="kw-2">&amp;mut </span>[u8]) -&gt; io::Result&lt;usize&gt;,
{
<span class="kw">if </span><span class="self">self</span>.buffer.len() == <span class="self">self</span>.consumed {
<span class="kw">if </span><span class="self">self</span>.offset == <span class="self">self</span>.total_bytes {
<span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="number">0</span>);
} <span class="kw">else if </span>buf.len() &gt;= <span class="self">self</span>.scanline_bytes {
<span class="comment">// If there is nothing buffered and the user requested a full scanline worth of
// data, skip buffering.
</span><span class="kw">let </span>bytes_read = read_scanline(<span class="kw-2">&amp;mut </span>buf[..<span class="self">self</span>.scanline_bytes])<span class="question-mark">?</span>;
<span class="self">self</span>.offset += u64::try_from(bytes_read).unwrap();
<span class="kw">return </span><span class="prelude-val">Ok</span>(bytes_read);
} <span class="kw">else </span>{
<span class="comment">// Lazily allocate buffer the first time that read is called with a buffer smaller
// than the scanline size.
</span><span class="kw">if </span><span class="self">self</span>.buffer.is_empty() {
<span class="self">self</span>.buffer.resize(<span class="self">self</span>.scanline_bytes, <span class="number">0</span>);
}
<span class="self">self</span>.consumed = <span class="number">0</span>;
<span class="kw">let </span>bytes_read = read_scanline(<span class="kw-2">&amp;mut </span><span class="self">self</span>.buffer[..])<span class="question-mark">?</span>;
<span class="self">self</span>.buffer.resize(bytes_read, <span class="number">0</span>);
<span class="self">self</span>.offset += u64::try_from(bytes_read).unwrap();
<span class="macro">assert!</span>(bytes_read == <span class="self">self</span>.scanline_bytes || <span class="self">self</span>.offset == <span class="self">self</span>.total_bytes);
}
}
<span class="comment">// Finally, copy bytes into output buffer.
</span><span class="kw">let </span>bytes_buffered = <span class="self">self</span>.buffer.len() - <span class="self">self</span>.consumed;
<span class="kw">if </span>bytes_buffered &gt; buf.len() {
<span class="kw">crate</span>::copy_memory(<span class="kw-2">&amp;</span><span class="self">self</span>.buffer[<span class="self">self</span>.consumed..][..buf.len()], <span class="kw-2">&amp;mut </span>buf[..]);
<span class="self">self</span>.consumed += buf.len();
<span class="prelude-val">Ok</span>(buf.len())
} <span class="kw">else </span>{
<span class="kw">crate</span>::copy_memory(<span class="kw-2">&amp;</span><span class="self">self</span>.buffer[<span class="self">self</span>.consumed..], <span class="kw-2">&amp;mut </span>buf[..bytes_buffered]);
<span class="self">self</span>.consumed = <span class="self">self</span>.buffer.len();
<span class="prelude-val">Ok</span>(bytes_buffered)
}
}
}
<span class="doccomment">/// Decodes a specific region of the image, represented by the rectangle
/// starting from ```x``` and ```y``` and having ```length``` and ```width```
</span><span class="attribute">#[allow(dead_code)]
</span><span class="comment">// When no image formats that use it are enabled
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>load_rect&lt;<span class="lifetime">&#39;a</span>, D, F, F1, F2, E&gt;(x: u32, y: u32, width: u32, height: u32, buf: <span class="kw-2">&amp;mut </span>[u8],
progress_callback: F,
decoder: <span class="kw-2">&amp;mut </span>D,
<span class="kw-2">mut </span>seek_scanline: F1,
<span class="kw-2">mut </span>read_scanline: F2) -&gt; ImageResult&lt;()&gt;
<span class="kw">where </span>D: ImageDecoder&lt;<span class="lifetime">&#39;a</span>&gt;,
F: Fn(Progress),
F1: FnMut(<span class="kw-2">&amp;mut </span>D, u64) -&gt; io::Result&lt;()&gt;,
F2: FnMut(<span class="kw-2">&amp;mut </span>D, <span class="kw-2">&amp;mut </span>[u8]) -&gt; <span class="prelude-ty">Result</span>&lt;(), E&gt;,
ImageError: From&lt;E&gt;,
{
<span class="kw">let </span>(x, y, width, height) = (u64::from(x), u64::from(y), u64::from(width), u64::from(height));
<span class="kw">let </span>dimensions = decoder.dimensions();
<span class="kw">let </span>bytes_per_pixel = u64::from(decoder.color_type().bytes_per_pixel());
<span class="kw">let </span>row_bytes = bytes_per_pixel * u64::from(dimensions.<span class="number">0</span>);
<span class="kw">let </span>scanline_bytes = decoder.scanline_bytes();
<span class="kw">let </span>total_bytes = width * height * bytes_per_pixel;
<span class="kw">if </span>buf.len() &lt; usize::try_from(total_bytes).unwrap_or(usize::MAX) {
<span class="macro">panic!</span>(<span class="string">&quot;output buffer too short\n expected `{}`, provided `{}`&quot;</span>, total_bytes, buf.len());
}
<span class="kw">let </span><span class="kw-2">mut </span>bytes_read = <span class="number">0u64</span>;
<span class="kw">let </span><span class="kw-2">mut </span>current_scanline = <span class="number">0</span>;
<span class="kw">let </span><span class="kw-2">mut </span>tmp = Vec::new();
<span class="kw">let </span><span class="kw-2">mut </span>tmp_scanline = <span class="prelude-val">None</span>;
{
<span class="comment">// Read a range of the image starting from byte number `start` and continuing until byte
// number `end`. Updates `current_scanline` and `bytes_read` appropiately.
</span><span class="kw">let </span><span class="kw-2">mut </span>read_image_range = |<span class="kw-2">mut </span>start: u64, end: u64| -&gt; ImageResult&lt;()&gt; {
<span class="comment">// If the first scanline we need is already stored in the temporary buffer, then handle
// it first.
</span><span class="kw">let </span>target_scanline = start / scanline_bytes;
<span class="kw">if </span>tmp_scanline == <span class="prelude-val">Some</span>(target_scanline) {
<span class="kw">let </span>position = target_scanline * scanline_bytes;
<span class="kw">let </span>offset = start.saturating_sub(position);
<span class="kw">let </span>len = (end - start)
.min(scanline_bytes - offset)
.min(end - position);
buf[(bytes_read <span class="kw">as </span>usize)..][..len <span class="kw">as </span>usize]
.copy_from_slice(<span class="kw-2">&amp;</span>tmp[offset <span class="kw">as </span>usize..][..len <span class="kw">as </span>usize]);
bytes_read += len;
start += len;
progress_callback(Progress {current: bytes_read, total: total_bytes});
<span class="kw">if </span>start == end {
<span class="kw">return </span><span class="prelude-val">Ok</span>(());
}
}
<span class="kw">let </span>target_scanline = start / scanline_bytes;
<span class="kw">if </span>target_scanline != current_scanline {
seek_scanline(decoder, target_scanline)<span class="question-mark">?</span>;
current_scanline = target_scanline;
}
<span class="kw">let </span><span class="kw-2">mut </span>position = current_scanline * scanline_bytes;
<span class="kw">while </span>position &lt; end {
<span class="kw">if </span>position &gt;= start &amp;&amp; end - position &gt;= scanline_bytes {
read_scanline(decoder, <span class="kw-2">&amp;mut </span>buf[(bytes_read <span class="kw">as </span>usize)..]
[..(scanline_bytes <span class="kw">as </span>usize)])<span class="question-mark">?</span>;
bytes_read += scanline_bytes;
} <span class="kw">else </span>{
tmp.resize(scanline_bytes <span class="kw">as </span>usize, <span class="number">0u8</span>);
read_scanline(decoder, <span class="kw-2">&amp;mut </span>tmp)<span class="question-mark">?</span>;
tmp_scanline = <span class="prelude-val">Some</span>(current_scanline);
<span class="kw">let </span>offset = start.saturating_sub(position);
<span class="kw">let </span>len = (end - start)
.min(scanline_bytes - offset)
.min(end - position);
buf[(bytes_read <span class="kw">as </span>usize)..][..len <span class="kw">as </span>usize]
.copy_from_slice(<span class="kw-2">&amp;</span>tmp[offset <span class="kw">as </span>usize..][..len <span class="kw">as </span>usize]);
bytes_read += len;
}
current_scanline += <span class="number">1</span>;
position += scanline_bytes;
progress_callback(Progress {current: bytes_read, total: total_bytes});
}
<span class="prelude-val">Ok</span>(())
};
<span class="kw">if </span>x + width &gt; u64::from(dimensions.<span class="number">0</span>) || y + height &gt; u64::from(dimensions.<span class="number">1</span>)
|| width == <span class="number">0 </span>|| height == <span class="number">0 </span>{
<span class="kw">return </span><span class="prelude-val">Err</span>(ImageError::Parameter(ParameterError::from_kind(
ParameterErrorKind::DimensionMismatch,
)));
}
<span class="kw">if </span>scanline_bytes &gt; usize::max_value() <span class="kw">as </span>u64 {
<span class="kw">return </span><span class="prelude-val">Err</span>(ImageError::Limits(LimitError::from_kind(
LimitErrorKind::InsufficientMemory,
)));
}
progress_callback(Progress {current: <span class="number">0</span>, total: total_bytes});
<span class="kw">if </span>x == <span class="number">0 </span>&amp;&amp; width == u64::from(dimensions.<span class="number">0</span>) {
<span class="kw">let </span>start = x * bytes_per_pixel + y * row_bytes;
<span class="kw">let </span>end = (x + width) * bytes_per_pixel + (y + height - <span class="number">1</span>) * row_bytes;
read_image_range(start, end)<span class="question-mark">?</span>;
} <span class="kw">else </span>{
<span class="kw">for </span>row <span class="kw">in </span>y..(y+height) {
<span class="kw">let </span>start = x * bytes_per_pixel + row * row_bytes;
<span class="kw">let </span>end = (x + width) * bytes_per_pixel + row * row_bytes;
read_image_range(start, end)<span class="question-mark">?</span>;
}
}
}
<span class="comment">// Seek back to the start
</span><span class="prelude-val">Ok</span>(seek_scanline(decoder, <span class="number">0</span>)<span class="question-mark">?</span>)
}
<span class="doccomment">/// Reads all of the bytes of a decoder into a Vec&lt;T&gt;. No particular alignment
/// of the output buffer is guaranteed.
///
/// Panics if there isn&#39;t enough memory to decode the image.
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>decoder_to_vec&lt;<span class="lifetime">&#39;a</span>, T&gt;(decoder: <span class="kw">impl </span>ImageDecoder&lt;<span class="lifetime">&#39;a</span>&gt;) -&gt; ImageResult&lt;Vec&lt;T&gt;&gt;
<span class="kw">where
</span>T: <span class="kw">crate</span>::traits::Primitive + bytemuck::Pod,
{
<span class="kw">let </span><span class="kw-2">mut </span>buf = <span class="macro">vec!</span>[num_traits::Zero::zero(); usize::try_from(decoder.total_bytes()).unwrap() / std::mem::size_of::&lt;T&gt;()];
decoder.read_image(bytemuck::cast_slice_mut(buf.as_mut_slice()))<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(buf)
}
<span class="doccomment">/// Represents the progress of an image operation.
///
/// Note that this is not necessarily accurate and no change to the values passed to the progress
/// function during decoding will be considered breaking. A decoder could in theory report the
/// progress `(0, 0)` if progress is unknown, without violating the interface contract of the type.
</span><span class="attribute">#[derive(Clone, Copy, Debug, PartialEq, Eq)]
</span><span class="kw">pub struct </span>Progress {
current: u64,
total: u64,
}
<span class="kw">impl </span>Progress {
<span class="doccomment">/// A measure of completed decoding.
</span><span class="kw">pub fn </span>current(<span class="self">self</span>) -&gt; u64 {
<span class="self">self</span>.current
}
<span class="doccomment">/// A measure of all necessary decoding work.
///
/// This is in general greater or equal than `current`.
</span><span class="kw">pub fn </span>total(<span class="self">self</span>) -&gt; u64 {
<span class="self">self</span>.total
}
<span class="doccomment">/// Calculate a measure for remaining decoding work.
</span><span class="kw">pub fn </span>remaining(<span class="self">self</span>) -&gt; u64 {
<span class="self">self</span>.total.max(<span class="self">self</span>.current) - <span class="self">self</span>.current
}
}
<span class="doccomment">/// The trait that all decoders implement
</span><span class="kw">pub trait </span>ImageDecoder&lt;<span class="lifetime">&#39;a</span>&gt;: Sized {
<span class="doccomment">/// The type of reader produced by `into_reader`.
</span><span class="kw">type </span>Reader: Read + <span class="lifetime">&#39;a</span>;
<span class="doccomment">/// Returns a tuple containing the width and height of the image
</span><span class="kw">fn </span>dimensions(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; (u32, u32);
<span class="doccomment">/// Returns the color type of the image data produced by this decoder
</span><span class="kw">fn </span>color_type(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; ColorType;
<span class="doccomment">/// Retuns the color type of the image file before decoding
</span><span class="kw">fn </span>original_color_type(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; ExtendedColorType {
<span class="self">self</span>.color_type().into()
}
<span class="doccomment">/// Returns a reader that can be used to obtain the bytes of the image. For the best
/// performance, always try to read at least `scanline_bytes` from the reader at a time. Reading
/// fewer bytes will cause the reader to perform internal buffering.
</span><span class="kw">fn </span>into_reader(<span class="self">self</span>) -&gt; ImageResult&lt;<span class="self">Self</span>::Reader&gt;;
<span class="doccomment">/// Returns the total number of bytes in the decoded image.
///
/// This is the size of the buffer that must be passed to `read_image` or
/// `read_image_with_progress`. The returned value may exceed usize::MAX, in
/// which case it isn&#39;t actually possible to construct a buffer to decode all the image data
/// into.
</span><span class="kw">fn </span>total_bytes(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; u64 {
<span class="kw">let </span>dimensions = <span class="self">self</span>.dimensions();
u64::from(dimensions.<span class="number">0</span>) * u64::from(dimensions.<span class="number">1</span>) * u64::from(<span class="self">self</span>.color_type().bytes_per_pixel())
}
<span class="doccomment">/// Returns the minimum number of bytes that can be efficiently read from this decoder. This may
/// be as few as 1 or as many as `total_bytes()`.
</span><span class="kw">fn </span>scanline_bytes(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; u64 {
<span class="self">self</span>.total_bytes()
}
<span class="doccomment">/// Returns all the bytes in the image.
///
/// This function takes a slice of bytes and writes the pixel data of the image into it.
/// Although not required, for certain color types callers may want to pass buffers which are
/// aligned to 2 or 4 byte boundaries to the slice can be cast to a [u16] or [u32]. To accommodate
/// such casts, the returned contents will always be in native endian.
///
/// # Panics
///
/// This function panics if buf.len() != self.total_bytes().
///
/// # Examples
///
/// ```no_build
/// use zerocopy::{AsBytes, FromBytes};
/// fn read_16bit_image(decoder: impl ImageDecoder) -&gt; Vec&lt;16&gt; {
/// let mut buf: Vec&lt;u16&gt; = vec![0; decoder.total_bytes()/2];
/// decoder.read_image(buf.as_bytes());
/// buf
/// }
</span><span class="kw">fn </span>read_image(<span class="self">self</span>, buf: <span class="kw-2">&amp;mut </span>[u8]) -&gt; ImageResult&lt;()&gt; {
<span class="self">self</span>.read_image_with_progress(buf, |<span class="kw">_</span>| {})
}
<span class="doccomment">/// Same as `read_image` but periodically calls the provided callback to give updates on loading
/// progress.
</span><span class="kw">fn </span>read_image_with_progress&lt;F: Fn(Progress)&gt;(
<span class="self">self</span>,
buf: <span class="kw-2">&amp;mut </span>[u8],
progress_callback: F,
) -&gt; ImageResult&lt;()&gt; {
<span class="macro">assert_eq!</span>(u64::try_from(buf.len()), <span class="prelude-val">Ok</span>(<span class="self">self</span>.total_bytes()));
<span class="kw">let </span>total_bytes = <span class="self">self</span>.total_bytes() <span class="kw">as </span>usize;
<span class="kw">let </span>scanline_bytes = <span class="self">self</span>.scanline_bytes() <span class="kw">as </span>usize;
<span class="kw">let </span>target_read_size = <span class="kw">if </span>scanline_bytes &lt; <span class="number">4096 </span>{
(<span class="number">4096 </span>/ scanline_bytes) * scanline_bytes
} <span class="kw">else </span>{
scanline_bytes
};
<span class="kw">let </span><span class="kw-2">mut </span>reader = <span class="self">self</span>.into_reader()<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>bytes_read = <span class="number">0</span>;
<span class="kw">while </span>bytes_read &lt; total_bytes {
<span class="kw">let </span>read_size = target_read_size.min(total_bytes - bytes_read);
reader.read_exact(<span class="kw-2">&amp;mut </span>buf[bytes_read..][..read_size])<span class="question-mark">?</span>;
bytes_read += read_size;
progress_callback(Progress {
current: bytes_read <span class="kw">as </span>u64,
total: total_bytes <span class="kw">as </span>u64,
});
}
<span class="prelude-val">Ok</span>(())
}
}
<span class="doccomment">/// Specialized image decoding not be supported by all formats
</span><span class="kw">pub trait </span>ImageDecoderExt&lt;<span class="lifetime">&#39;a</span>&gt;: ImageDecoder&lt;<span class="lifetime">&#39;a</span>&gt; + Sized {
<span class="doccomment">/// Decode a rectangular section of the image; see [`read_rect_with_progress()`](#fn.read_rect_with_progress).
</span><span class="kw">fn </span>read_rect(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
x: u32,
y: u32,
width: u32,
height: u32,
buf: <span class="kw-2">&amp;mut </span>[u8],
) -&gt; ImageResult&lt;()&gt; {
<span class="self">self</span>.read_rect_with_progress(x, y, width, height, buf, |<span class="kw">_</span>|{})
}
<span class="doccomment">/// Decode a rectangular section of the image, periodically reporting progress.
///
/// The output buffer will be filled with fields specified by
/// [`ImageDecoder::color_type()`](trait.ImageDecoder.html#fn.color_type),
/// in that order, each field represented in native-endian.
///
/// The progress callback will be called at least once at the start and the end of decoding,
/// implementations are encouraged to call this more often,
/// with a frequency meaningful for display to the end-user.
///
/// This function will panic if the output buffer isn&#39;t at least
/// `color_type().bytes_per_pixel() * color_type().channel_count() * width * height` bytes long.
</span><span class="kw">fn </span>read_rect_with_progress&lt;F: Fn(Progress)&gt;(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
x: u32,
y: u32,
width: u32,
height: u32,
buf: <span class="kw-2">&amp;mut </span>[u8],
progress_callback: F,
) -&gt; ImageResult&lt;()&gt;;
}
<span class="doccomment">/// AnimationDecoder trait
</span><span class="kw">pub trait </span>AnimationDecoder&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="doccomment">/// Consume the decoder producing a series of frames.
</span><span class="kw">fn </span>into_frames(<span class="self">self</span>) -&gt; Frames&lt;<span class="lifetime">&#39;a</span>&gt;;
}
<span class="doccomment">/// The trait all encoders implement
</span><span class="kw">pub trait </span>ImageEncoder {
<span class="doccomment">/// Writes all the bytes in an image to the encoder.
///
/// This function takes a slice of bytes of the pixel data of the image
/// and encodes them. Unlike particular format encoders inherent impl encode
/// methods where endianness is not specified, here image data bytes should
/// always be in native endian. The implementor will reorder the endianess
/// as necessary for the target encoding format.
///
/// See also `ImageDecoder::read_image` which reads byte buffers into
/// native endian.
</span><span class="kw">fn </span>write_image(
<span class="self">self</span>,
buf: <span class="kw-2">&amp;</span>[u8],
width: u32,
height: u32,
color_type: ColorType,
) -&gt; ImageResult&lt;()&gt;;
}
<span class="doccomment">/// Immutable pixel iterator
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>Pixels&lt;<span class="lifetime">&#39;a</span>, I: <span class="question-mark">?</span>Sized + <span class="lifetime">&#39;a</span>&gt; {
image: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>I,
x: u32,
y: u32,
width: u32,
height: u32,
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>, I: GenericImageView&gt; Iterator <span class="kw">for </span>Pixels&lt;<span class="lifetime">&#39;a</span>, I&gt; {
<span class="kw">type </span>Item = (u32, u32, I::Pixel);
<span class="kw">fn </span>next(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;(u32, u32, I::Pixel)&gt; {
<span class="kw">if </span><span class="self">self</span>.x &gt;= <span class="self">self</span>.width {
<span class="self">self</span>.x = <span class="number">0</span>;
<span class="self">self</span>.y += <span class="number">1</span>;
}
<span class="kw">if </span><span class="self">self</span>.y &gt;= <span class="self">self</span>.height {
<span class="prelude-val">None
</span>} <span class="kw">else </span>{
<span class="kw">let </span>pixel = <span class="self">self</span>.image.get_pixel(<span class="self">self</span>.x, <span class="self">self</span>.y);
<span class="kw">let </span>p = (<span class="self">self</span>.x, <span class="self">self</span>.y, pixel);
<span class="self">self</span>.x += <span class="number">1</span>;
<span class="prelude-val">Some</span>(p)
}
}
}
<span class="kw">impl</span>&lt;I: <span class="question-mark">?</span>Sized&gt; Clone <span class="kw">for </span>Pixels&lt;<span class="lifetime">&#39;_</span>, I&gt; {
<span class="kw">fn </span>clone(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="self">Self </span>{
Pixels { ..<span class="kw-2">*</span><span class="self">self </span>}
}
}
<span class="doccomment">/// Trait to inspect an image.
</span><span class="kw">pub trait </span>GenericImageView {
<span class="doccomment">/// The type of pixel.
</span><span class="kw">type </span>Pixel: Pixel;
<span class="doccomment">/// Underlying image type. This is mainly used by SubImages in order to
/// always have a reference to the original image. This allows for less
/// indirections and it eases the use of nested SubImages.
</span><span class="kw">type </span>InnerImageView: GenericImageView&lt;Pixel = <span class="self">Self</span>::Pixel&gt;;
<span class="doccomment">/// The width and height of this image.
</span><span class="kw">fn </span>dimensions(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; (u32, u32);
<span class="doccomment">/// The width of this image.
</span><span class="kw">fn </span>width(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; u32 {
<span class="kw">let </span>(w, <span class="kw">_</span>) = <span class="self">self</span>.dimensions();
w
}
<span class="doccomment">/// The height of this image.
</span><span class="kw">fn </span>height(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; u32 {
<span class="kw">let </span>(<span class="kw">_</span>, h) = <span class="self">self</span>.dimensions();
h
}
<span class="doccomment">/// The bounding rectangle of this image.
</span><span class="kw">fn </span>bounds(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; (u32, u32, u32, u32);
<span class="doccomment">/// Returns true if this x, y coordinate is contained inside the image.
</span><span class="kw">fn </span>in_bounds(<span class="kw-2">&amp;</span><span class="self">self</span>, x: u32, y: u32) -&gt; bool {
<span class="kw">let </span>(ix, iy, iw, ih) = <span class="self">self</span>.bounds();
x &gt;= ix &amp;&amp; x &lt; ix + iw &amp;&amp; y &gt;= iy &amp;&amp; y &lt; iy + ih
}
<span class="doccomment">/// Returns the pixel located at (x, y). Indexed from top left.
///
/// # Panics
///
/// Panics if `(x, y)` is out of bounds.
///
/// TODO: change this signature to &amp;P
</span><span class="kw">fn </span>get_pixel(<span class="kw-2">&amp;</span><span class="self">self</span>, x: u32, y: u32) -&gt; <span class="self">Self</span>::Pixel;
<span class="doccomment">/// Returns the pixel located at (x, y). Indexed from top left.
///
/// This function can be implemented in a way that ignores bounds checking.
/// # Safety
///
/// The coordinates must be [`in_bounds`] of the image.
///
/// [`in_bounds`]: #method.in_bounds
</span><span class="kw">unsafe fn </span>unsafe_get_pixel(<span class="kw-2">&amp;</span><span class="self">self</span>, x: u32, y: u32) -&gt; <span class="self">Self</span>::Pixel {
<span class="self">self</span>.get_pixel(x, y)
}
<span class="doccomment">/// Returns an Iterator over the pixels of this image.
/// The iterator yields the coordinates of each pixel
/// along with their value
</span><span class="kw">fn </span>pixels(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Pixels&lt;<span class="self">Self</span>&gt; {
<span class="kw">let </span>(width, height) = <span class="self">self</span>.dimensions();
Pixels {
image: <span class="self">self</span>,
x: <span class="number">0</span>,
y: <span class="number">0</span>,
width,
height,
}
}
<span class="doccomment">/// Returns a reference to the underlying image.
</span><span class="kw">fn </span>inner(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span><span class="self">Self</span>::InnerImageView;
<span class="doccomment">/// Returns an subimage that is an immutable view into this image.
/// You can use [`GenericImage::sub_image`] if you need a mutable view instead.
/// The coordinates set the position of the top left corner of the view.
</span><span class="kw">fn </span>view(<span class="kw-2">&amp;</span><span class="self">self</span>, x: u32, y: u32, width: u32, height: u32) -&gt; SubImage&lt;<span class="kw-2">&amp;</span><span class="self">Self</span>::InnerImageView&gt; {
SubImage::new(<span class="self">self</span>.inner(), x, y, width, height)
}
}
<span class="doccomment">/// A trait for manipulating images.
</span><span class="kw">pub trait </span>GenericImage: GenericImageView {
<span class="doccomment">/// Underlying image type. This is mainly used by SubImages in order to
/// always have a reference to the original image. This allows for less
/// indirections and it eases the use of nested SubImages.
</span><span class="kw">type </span>InnerImage: GenericImage&lt;Pixel = <span class="self">Self</span>::Pixel&gt;;
<span class="doccomment">/// Gets a reference to the mutable pixel at location `(x, y)`. Indexed from top left.
///
/// # Panics
///
/// Panics if `(x, y)` is out of bounds.
</span><span class="kw">fn </span>get_pixel_mut(<span class="kw-2">&amp;mut </span><span class="self">self</span>, x: u32, y: u32) -&gt; <span class="kw-2">&amp;mut </span><span class="self">Self</span>::Pixel;
<span class="doccomment">/// Put a pixel at location (x, y). Indexed from top left.
///
/// # Panics
///
/// Panics if `(x, y)` is out of bounds.
</span><span class="kw">fn </span>put_pixel(<span class="kw-2">&amp;mut </span><span class="self">self</span>, x: u32, y: u32, pixel: <span class="self">Self</span>::Pixel);
<span class="doccomment">/// Puts a pixel at location (x, y). Indexed from top left.
///
/// This function can be implemented in a way that ignores bounds checking.
/// # Safety
///
/// The coordinates must be [`in_bounds`] of the image.
///
/// [`in_bounds`]: traits.GenericImageView.html#method.in_bounds
</span><span class="kw">unsafe fn </span>unsafe_put_pixel(<span class="kw-2">&amp;mut </span><span class="self">self</span>, x: u32, y: u32, pixel: <span class="self">Self</span>::Pixel) {
<span class="self">self</span>.put_pixel(x, y, pixel);
}
<span class="doccomment">/// Put a pixel at location (x, y), taking into account alpha channels
///
/// DEPRECATED: This method will be removed. Blend the pixel directly instead.
</span><span class="kw">fn </span>blend_pixel(<span class="kw-2">&amp;mut </span><span class="self">self</span>, x: u32, y: u32, pixel: <span class="self">Self</span>::Pixel);
<span class="doccomment">/// Copies all of the pixels from another image into this image.
///
/// The other image is copied with the top-left corner of the
/// other image placed at (x, y).
///
/// In order to copy only a piece of the other image, use [`GenericImageView::view`].
///
/// You can use [`FlatSamples`] to source pixels from an arbitrary regular raster of channel
/// values, for example from a foreign interface or a fixed image.
///
/// # Returns
/// Returns an error if the image is too large to be copied at the given position
///
/// [`GenericImageView::view`]: trait.GenericImageView.html#method.view
/// [`FlatSamples`]: flat/struct.FlatSamples.html
</span><span class="kw">fn </span>copy_from&lt;O&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, other: <span class="kw-2">&amp;</span>O, x: u32, y: u32) -&gt; ImageResult&lt;()&gt;
<span class="kw">where
</span>O: GenericImageView&lt;Pixel = <span class="self">Self</span>::Pixel&gt;,
{
<span class="comment">// Do bounds checking here so we can use the non-bounds-checking
// functions to copy pixels.
</span><span class="kw">if </span><span class="self">self</span>.width() &lt; other.width() + x || <span class="self">self</span>.height() &lt; other.height() + y {
<span class="kw">return </span><span class="prelude-val">Err</span>(ImageError::Parameter(ParameterError::from_kind(
ParameterErrorKind::DimensionMismatch,
)));
}
<span class="kw">for </span>k <span class="kw">in </span><span class="number">0</span>..other.height() {
<span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..other.width() {
<span class="kw">let </span>p = other.get_pixel(i, k);
<span class="self">self</span>.put_pixel(i + x, k + y, p);
}
}
<span class="prelude-val">Ok</span>(())
}
<span class="doccomment">/// Copies all of the pixels from one part of this image to another part of this image.
///
/// The destination rectangle of the copy is specified with the top-left corner placed at (x, y).
///
/// # Returns
/// `true` if the copy was successful, `false` if the image could not
/// be copied due to size constraints.
</span><span class="kw">fn </span>copy_within(<span class="kw-2">&amp;mut </span><span class="self">self</span>, source: Rect, x: u32, y: u32) -&gt; bool {
<span class="kw">let </span>Rect { x: sx, y: sy, width, height } = source;
<span class="kw">let </span>dx = x;
<span class="kw">let </span>dy = y;
<span class="macro">assert!</span>(sx &lt; <span class="self">self</span>.width() &amp;&amp; dx &lt; <span class="self">self</span>.width());
<span class="macro">assert!</span>(sy &lt; <span class="self">self</span>.height() &amp;&amp; dy &lt; <span class="self">self</span>.height());
<span class="kw">if </span><span class="self">self</span>.width() - dx.max(sx) &lt; width || <span class="self">self</span>.height() - dy.max(sy) &lt; height {
<span class="kw">return </span><span class="bool-val">false</span>;
}
<span class="comment">// since `.rev()` creates a new dype we would either have to go with dynamic dispatch for the ranges
// or have quite a lot of code bloat. A macro gives us static dispatch with less visible bloat.
</span><span class="macro">macro_rules! </span>copy_within_impl_ {
(<span class="macro-nonterminal">$xiter</span>:expr, <span class="macro-nonterminal">$yiter</span>:expr) =&gt; {
<span class="kw">for </span>y <span class="kw">in </span><span class="macro-nonterminal">$yiter </span>{
<span class="kw">let </span>sy = sy + y;
<span class="kw">let </span>dy = dy + y;
<span class="kw">for </span>x <span class="kw">in </span><span class="macro-nonterminal">$xiter </span>{
<span class="kw">let </span>sx = sx + x;
<span class="kw">let </span>dx = dx + x;
<span class="kw">let </span>pixel = <span class="self">self</span>.get_pixel(sx, sy);
<span class="self">self</span>.put_pixel(dx, dy, pixel);
}
}
};
}
<span class="comment">// check how target and source rectangles relate to each other so we dont overwrite data before we copied it.
</span><span class="kw">match </span>(sx &lt; dx, sy &lt; dy) {
(<span class="bool-val">true</span>, <span class="bool-val">true</span>) =&gt; <span class="macro">copy_within_impl_!</span>((<span class="number">0</span>..width).rev(), (<span class="number">0</span>..height).rev()),
(<span class="bool-val">true</span>, <span class="bool-val">false</span>) =&gt; <span class="macro">copy_within_impl_!</span>((<span class="number">0</span>..width).rev(), <span class="number">0</span>..height),
(<span class="bool-val">false</span>, <span class="bool-val">true</span>) =&gt; <span class="macro">copy_within_impl_!</span>(<span class="number">0</span>..width, (<span class="number">0</span>..height).rev()),
(<span class="bool-val">false</span>, <span class="bool-val">false</span>) =&gt; <span class="macro">copy_within_impl_!</span>(<span class="number">0</span>..width, <span class="number">0</span>..height),
}
<span class="bool-val">true
</span>}
<span class="doccomment">/// Returns a mutable reference to the underlying image.
</span><span class="kw">fn </span>inner_mut(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;mut </span><span class="self">Self</span>::InnerImage;
<span class="doccomment">/// Returns a mutable subimage that is a view into this image.
/// If you want an immutable subimage instead, use [`GenericImageView::view`]
/// The coordinates set the position of the top left corner of the SubImage.
</span><span class="kw">fn </span>sub_image(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
x: u32,
y: u32,
width: u32,
height: u32,
) -&gt; SubImage&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>::InnerImage&gt; {
SubImage::new(<span class="self">self</span>.inner_mut(), x, y, width, height)
}
}
<span class="doccomment">/// A View into another image
///
/// Instances of this struct can be created using:
/// - [`GenericImage::sub_image`] to create a mutable view,
/// - [`GenericImageView::view`] to create an immutable view,
/// - [`SubImage::new`] to instantiate the struct directly.
</span><span class="kw">pub struct </span>SubImage&lt;I&gt; {
image: I,
xoffset: u32,
yoffset: u32,
xstride: u32,
ystride: u32,
}
<span class="doccomment">/// Alias to access Pixel behind a reference
</span><span class="kw">type </span>DerefPixel&lt;I&gt; = &lt;&lt;I <span class="kw">as </span>Deref&gt;::Target <span class="kw">as </span>GenericImageView&gt;::Pixel;
<span class="doccomment">/// Alias to access Subpixel behind a reference
</span><span class="kw">type </span>DerefSubpixel&lt;I&gt; = &lt;DerefPixel&lt;I&gt; <span class="kw">as </span>Pixel&gt;::Subpixel;
<span class="kw">impl</span>&lt;I&gt; SubImage&lt;I&gt; {
<span class="doccomment">/// Construct a new subimage
/// The coordinates set the position of the top left corner of the SubImage.
</span><span class="kw">pub fn </span>new(image: I, x: u32, y: u32, width: u32, height: u32) -&gt; SubImage&lt;I&gt; {
SubImage {
image,
xoffset: x,
yoffset: y,
xstride: width,
ystride: height,
}
}
<span class="doccomment">/// Change the coordinates of this subimage.
</span><span class="kw">pub fn </span>change_bounds(<span class="kw-2">&amp;mut </span><span class="self">self</span>, x: u32, y: u32, width: u32, height: u32) {
<span class="self">self</span>.xoffset = x;
<span class="self">self</span>.yoffset = y;
<span class="self">self</span>.xstride = width;
<span class="self">self</span>.ystride = height;
}
<span class="doccomment">/// Convert this subimage to an ImageBuffer
</span><span class="kw">pub fn </span>to_image(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; ImageBuffer&lt;DerefPixel&lt;I&gt;, Vec&lt;DerefSubpixel&lt;I&gt;&gt;&gt;
<span class="kw">where
</span>I: Deref,
I::Target: GenericImage + <span class="lifetime">&#39;static</span>,
{
<span class="kw">let </span><span class="kw-2">mut </span>out = ImageBuffer::new(<span class="self">self</span>.xstride, <span class="self">self</span>.ystride);
<span class="kw">let </span>borrowed = <span class="self">self</span>.image.deref();
<span class="kw">for </span>y <span class="kw">in </span><span class="number">0</span>..<span class="self">self</span>.ystride {
<span class="kw">for </span>x <span class="kw">in </span><span class="number">0</span>..<span class="self">self</span>.xstride {
<span class="kw">let </span>p = borrowed.get_pixel(x + <span class="self">self</span>.xoffset, y + <span class="self">self</span>.yoffset);
out.put_pixel(x, y, p);
}
}
out
}
}
<span class="attribute">#[allow(deprecated)]
</span><span class="kw">impl</span>&lt;I&gt; GenericImageView <span class="kw">for </span>SubImage&lt;I&gt;
<span class="kw">where
</span>I: Deref,
I::Target: GenericImageView + Sized,
{
<span class="kw">type </span>Pixel = DerefPixel&lt;I&gt;;
<span class="kw">type </span>InnerImageView = I::Target;
<span class="kw">fn </span>dimensions(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; (u32, u32) {
(<span class="self">self</span>.xstride, <span class="self">self</span>.ystride)
}
<span class="kw">fn </span>bounds(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; (u32, u32, u32, u32) {
(<span class="self">self</span>.xoffset, <span class="self">self</span>.yoffset, <span class="self">self</span>.xstride, <span class="self">self</span>.ystride)
}
<span class="kw">fn </span>get_pixel(<span class="kw-2">&amp;</span><span class="self">self</span>, x: u32, y: u32) -&gt; <span class="self">Self</span>::Pixel {
<span class="self">self</span>.image.get_pixel(x + <span class="self">self</span>.xoffset, y + <span class="self">self</span>.yoffset)
}
<span class="kw">fn </span>view(<span class="kw-2">&amp;</span><span class="self">self</span>, x: u32, y: u32, width: u32, height: u32) -&gt; SubImage&lt;<span class="kw-2">&amp;</span><span class="self">Self</span>::InnerImageView&gt; {
<span class="kw">let </span>x = <span class="self">self</span>.xoffset + x;
<span class="kw">let </span>y = <span class="self">self</span>.yoffset + y;
SubImage::new(<span class="self">self</span>.inner(), x, y, width, height)
}
<span class="kw">fn </span>inner(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span><span class="self">Self</span>::InnerImageView {
<span class="kw-2">&amp;</span><span class="self">self</span>.image
}
}
<span class="attribute">#[allow(deprecated)]
</span><span class="kw">impl</span>&lt;I&gt; GenericImage <span class="kw">for </span>SubImage&lt;I&gt;
<span class="kw">where
</span>I: DerefMut,
I::Target: GenericImage + Sized,
{
<span class="kw">type </span>InnerImage = I::Target;
<span class="kw">fn </span>get_pixel_mut(<span class="kw-2">&amp;mut </span><span class="self">self</span>, x: u32, y: u32) -&gt; <span class="kw-2">&amp;mut </span><span class="self">Self</span>::Pixel {
<span class="self">self</span>.image.get_pixel_mut(x + <span class="self">self</span>.xoffset, y + <span class="self">self</span>.yoffset)
}
<span class="kw">fn </span>put_pixel(<span class="kw-2">&amp;mut </span><span class="self">self</span>, x: u32, y: u32, pixel: <span class="self">Self</span>::Pixel) {
<span class="self">self</span>.image
.put_pixel(x + <span class="self">self</span>.xoffset, y + <span class="self">self</span>.yoffset, pixel)
}
<span class="doccomment">/// DEPRECATED: This method will be removed. Blend the pixel directly instead.
</span><span class="kw">fn </span>blend_pixel(<span class="kw-2">&amp;mut </span><span class="self">self</span>, x: u32, y: u32, pixel: <span class="self">Self</span>::Pixel) {
<span class="self">self</span>.image
.blend_pixel(x + <span class="self">self</span>.xoffset, y + <span class="self">self</span>.yoffset, pixel)
}
<span class="kw">fn </span>sub_image(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
x: u32,
y: u32,
width: u32,
height: u32,
) -&gt; SubImage&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>::InnerImage&gt; {
<span class="kw">let </span>x = <span class="self">self</span>.xoffset + x;
<span class="kw">let </span>y = <span class="self">self</span>.yoffset + y;
SubImage::new(<span class="self">self</span>.inner_mut(), x, y, width, height)
}
<span class="kw">fn </span>inner_mut(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;mut </span><span class="self">Self</span>::InnerImage {
<span class="kw-2">&amp;mut </span><span class="self">self</span>.image
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span>std::io;
<span class="kw">use </span>std::path::Path;
<span class="kw">use super</span>::{ColorType, ImageDecoder, ImageResult, GenericImage, GenericImageView, load_rect, ImageFormat};
<span class="kw">use crate</span>::{GrayImage, ImageBuffer};
<span class="kw">use </span><span class="kw">crate</span>::color::Rgba;
<span class="kw">use </span><span class="kw">crate</span>::math::Rect;
<span class="attribute">#[test]
</span><span class="doccomment">/// Test that alpha blending works as expected
</span><span class="kw">fn </span>test_image_alpha_blending() {
<span class="kw">let </span><span class="kw-2">mut </span>target = ImageBuffer::new(<span class="number">1</span>, <span class="number">1</span>);
target.put_pixel(<span class="number">0</span>, <span class="number">0</span>, Rgba([<span class="number">255u8</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">255</span>]));
<span class="macro">assert!</span>(<span class="kw-2">*</span>target.get_pixel(<span class="number">0</span>, <span class="number">0</span>) == Rgba([<span class="number">255</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">255</span>]));
target.blend_pixel(<span class="number">0</span>, <span class="number">0</span>, Rgba([<span class="number">0</span>, <span class="number">255</span>, <span class="number">0</span>, <span class="number">255</span>]));
<span class="macro">assert!</span>(<span class="kw-2">*</span>target.get_pixel(<span class="number">0</span>, <span class="number">0</span>) == Rgba([<span class="number">0</span>, <span class="number">255</span>, <span class="number">0</span>, <span class="number">255</span>]));
<span class="comment">// Blending an alpha channel onto a solid background
</span>target.blend_pixel(<span class="number">0</span>, <span class="number">0</span>, Rgba([<span class="number">255</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">127</span>]));
<span class="macro">assert!</span>(<span class="kw-2">*</span>target.get_pixel(<span class="number">0</span>, <span class="number">0</span>) == Rgba([<span class="number">127</span>, <span class="number">127</span>, <span class="number">0</span>, <span class="number">255</span>]));
<span class="comment">// Blending two alpha channels
</span>target.put_pixel(<span class="number">0</span>, <span class="number">0</span>, Rgba([<span class="number">0</span>, <span class="number">255</span>, <span class="number">0</span>, <span class="number">127</span>]));
target.blend_pixel(<span class="number">0</span>, <span class="number">0</span>, Rgba([<span class="number">255</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">127</span>]));
<span class="macro">assert!</span>(<span class="kw-2">*</span>target.get_pixel(<span class="number">0</span>, <span class="number">0</span>) == Rgba([<span class="number">169</span>, <span class="number">85</span>, <span class="number">0</span>, <span class="number">190</span>]));
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_in_bounds() {
<span class="kw">let </span><span class="kw-2">mut </span>target = ImageBuffer::new(<span class="number">2</span>, <span class="number">2</span>);
target.put_pixel(<span class="number">0</span>, <span class="number">0</span>, Rgba([<span class="number">255u8</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">255</span>]));
<span class="macro">assert!</span>(target.in_bounds(<span class="number">0</span>, <span class="number">0</span>));
<span class="macro">assert!</span>(target.in_bounds(<span class="number">1</span>, <span class="number">0</span>));
<span class="macro">assert!</span>(target.in_bounds(<span class="number">0</span>, <span class="number">1</span>));
<span class="macro">assert!</span>(target.in_bounds(<span class="number">1</span>, <span class="number">1</span>));
<span class="macro">assert!</span>(!target.in_bounds(<span class="number">2</span>, <span class="number">0</span>));
<span class="macro">assert!</span>(!target.in_bounds(<span class="number">0</span>, <span class="number">2</span>));
<span class="macro">assert!</span>(!target.in_bounds(<span class="number">2</span>, <span class="number">2</span>));
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_can_subimage_clone_nonmut() {
<span class="kw">let </span><span class="kw-2">mut </span>source = ImageBuffer::new(<span class="number">3</span>, <span class="number">3</span>);
source.put_pixel(<span class="number">1</span>, <span class="number">1</span>, Rgba([<span class="number">255u8</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">255</span>]));
<span class="comment">// A non-mutable copy of the source image
</span><span class="kw">let </span>source = source.clone();
<span class="comment">// Clone a view into non-mutable to a separate buffer
</span><span class="kw">let </span>cloned = source.view(<span class="number">1</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">1</span>).to_image();
<span class="macro">assert!</span>(cloned.get_pixel(<span class="number">0</span>, <span class="number">0</span>) == source.get_pixel(<span class="number">1</span>, <span class="number">1</span>));
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_can_nest_views() {
<span class="kw">let </span><span class="kw-2">mut </span>source = ImageBuffer::from_pixel(<span class="number">3</span>, <span class="number">3</span>, Rgba([<span class="number">255u8</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">255</span>]));
{
<span class="kw">let </span><span class="kw-2">mut </span>sub1 = source.sub_image(<span class="number">0</span>, <span class="number">0</span>, <span class="number">2</span>, <span class="number">2</span>);
<span class="kw">let </span><span class="kw-2">mut </span>sub2 = sub1.sub_image(<span class="number">1</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">1</span>);
sub2.put_pixel(<span class="number">0</span>, <span class="number">0</span>, Rgba([<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>]));
}
<span class="macro">assert_eq!</span>(<span class="kw-2">*</span>source.get_pixel(<span class="number">1</span>, <span class="number">1</span>), Rgba([<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>]));
<span class="kw">let </span>view1 = source.view(<span class="number">0</span>, <span class="number">0</span>, <span class="number">2</span>, <span class="number">2</span>);
<span class="macro">assert_eq!</span>(<span class="kw-2">*</span>source.get_pixel(<span class="number">1</span>, <span class="number">1</span>), view1.get_pixel(<span class="number">1</span>, <span class="number">1</span>));
<span class="kw">let </span>view2 = view1.view(<span class="number">1</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">1</span>);
<span class="macro">assert_eq!</span>(<span class="kw-2">*</span>source.get_pixel(<span class="number">1</span>, <span class="number">1</span>), view2.get_pixel(<span class="number">0</span>, <span class="number">0</span>));
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_load_rect() {
<span class="kw">struct </span>MockDecoder {scanline_number: u64, scanline_bytes: u64}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; ImageDecoder&lt;<span class="lifetime">&#39;a</span>&gt; <span class="kw">for </span>MockDecoder {
<span class="kw">type </span>Reader = Box&lt;<span class="kw">dyn </span>io::Read&gt;;
<span class="kw">fn </span>dimensions(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; (u32, u32) {(<span class="number">5</span>, <span class="number">5</span>)}
<span class="kw">fn </span>color_type(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; ColorType { ColorType::L8 }
<span class="kw">fn </span>into_reader(<span class="self">self</span>) -&gt; ImageResult&lt;<span class="self">Self</span>::Reader&gt; {<span class="macro">unimplemented!</span>()}
<span class="kw">fn </span>scanline_bytes(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; u64 { <span class="self">self</span>.scanline_bytes }
}
<span class="kw">const </span>DATA: [u8; <span class="number">25</span>] = [<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>,
<span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>,
<span class="number">10</span>, <span class="number">11</span>, <span class="number">12</span>, <span class="number">13</span>, <span class="number">14</span>,
<span class="number">15</span>, <span class="number">16</span>, <span class="number">17</span>, <span class="number">18</span>, <span class="number">19</span>,
<span class="number">20</span>, <span class="number">21</span>, <span class="number">22</span>, <span class="number">23</span>, <span class="number">24</span>];
<span class="kw">fn </span>seek_scanline(m: <span class="kw-2">&amp;mut </span>MockDecoder, n: u64) -&gt; io::Result&lt;()&gt; {
m.scanline_number = n;
<span class="prelude-val">Ok</span>(())
}
<span class="kw">fn </span>read_scanline(m: <span class="kw-2">&amp;mut </span>MockDecoder, buf: <span class="kw-2">&amp;mut </span>[u8]) -&gt; io::Result&lt;()&gt; {
<span class="kw">let </span>bytes_read = m.scanline_number * m.scanline_bytes;
<span class="kw">if </span>bytes_read &gt;= <span class="number">25 </span>{
<span class="kw">return </span><span class="prelude-val">Ok</span>(());
}
<span class="kw">let </span>len = m.scanline_bytes.min(<span class="number">25 </span>- bytes_read);
buf[..(len <span class="kw">as </span>usize)].copy_from_slice(<span class="kw-2">&amp;</span>DATA[(bytes_read <span class="kw">as </span>usize)..][..(len <span class="kw">as </span>usize)]);
m.scanline_number += <span class="number">1</span>;
<span class="prelude-val">Ok</span>(())
}
<span class="kw">for </span>scanline_bytes <span class="kw">in </span><span class="number">1</span>..<span class="number">30 </span>{
<span class="kw">let </span><span class="kw-2">mut </span>output = [<span class="number">0u8</span>; <span class="number">26</span>];
load_rect(<span class="number">0</span>, <span class="number">0</span>, <span class="number">5</span>, <span class="number">5</span>, <span class="kw-2">&amp;mut </span>output, |<span class="kw">_</span>|{},
<span class="kw-2">&amp;mut </span>MockDecoder{scanline_number:<span class="number">0</span>, scanline_bytes},
seek_scanline, read_scanline).unwrap();
<span class="macro">assert_eq!</span>(output[<span class="number">0</span>..<span class="number">25</span>], DATA);
<span class="macro">assert_eq!</span>(output[<span class="number">25</span>], <span class="number">0</span>);
output = [<span class="number">0u8</span>; <span class="number">26</span>];
load_rect(<span class="number">3</span>, <span class="number">2</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="kw-2">&amp;mut </span>output, |<span class="kw">_</span>|{},
<span class="kw-2">&amp;mut </span>MockDecoder{scanline_number:<span class="number">0</span>, scanline_bytes},
seek_scanline, read_scanline).unwrap();
<span class="macro">assert_eq!</span>(output[<span class="number">0</span>..<span class="number">2</span>], [<span class="number">13</span>, <span class="number">0</span>]);
output = [<span class="number">0u8</span>; <span class="number">26</span>];
load_rect(<span class="number">3</span>, <span class="number">2</span>, <span class="number">2</span>, <span class="number">2</span>, <span class="kw-2">&amp;mut </span>output, |<span class="kw">_</span>|{},
<span class="kw-2">&amp;mut </span>MockDecoder{scanline_number:<span class="number">0</span>, scanline_bytes},
seek_scanline, read_scanline).unwrap();
<span class="macro">assert_eq!</span>(output[<span class="number">0</span>..<span class="number">5</span>], [<span class="number">13</span>, <span class="number">14</span>, <span class="number">18</span>, <span class="number">19</span>, <span class="number">0</span>]);
output = [<span class="number">0u8</span>; <span class="number">26</span>];
load_rect(<span class="number">1</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">4</span>, <span class="kw-2">&amp;mut </span>output, |<span class="kw">_</span>|{},
<span class="kw-2">&amp;mut </span>MockDecoder{scanline_number:<span class="number">0</span>, scanline_bytes},
seek_scanline, read_scanline).unwrap();
<span class="macro">assert_eq!</span>(output[<span class="number">0</span>..<span class="number">9</span>], [<span class="number">6</span>, <span class="number">7</span>, <span class="number">11</span>, <span class="number">12</span>, <span class="number">16</span>, <span class="number">17</span>, <span class="number">21</span>, <span class="number">22</span>, <span class="number">0</span>]);
}
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_load_rect_single_scanline() {
<span class="kw">const </span>DATA: [u8; <span class="number">25</span>] = [<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>,
<span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>,
<span class="number">10</span>, <span class="number">11</span>, <span class="number">12</span>, <span class="number">13</span>, <span class="number">14</span>,
<span class="number">15</span>, <span class="number">16</span>, <span class="number">17</span>, <span class="number">18</span>, <span class="number">19</span>,
<span class="number">20</span>, <span class="number">21</span>, <span class="number">22</span>, <span class="number">23</span>, <span class="number">24</span>];
<span class="kw">struct </span>MockDecoder;
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; ImageDecoder&lt;<span class="lifetime">&#39;a</span>&gt; <span class="kw">for </span>MockDecoder {
<span class="kw">type </span>Reader = Box&lt;<span class="kw">dyn </span>io::Read&gt;;
<span class="kw">fn </span>dimensions(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; (u32, u32) {(<span class="number">5</span>, <span class="number">5</span>)}
<span class="kw">fn </span>color_type(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; ColorType { ColorType::L8 }
<span class="kw">fn </span>into_reader(<span class="self">self</span>) -&gt; ImageResult&lt;<span class="self">Self</span>::Reader&gt; {<span class="macro">unimplemented!</span>()}
<span class="kw">fn </span>scanline_bytes(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; u64 { <span class="number">25 </span>}
}
<span class="comment">// Ensure that seek scanline is called only once.
</span><span class="kw">let </span><span class="kw-2">mut </span>seeks = <span class="number">0</span>;
<span class="kw">let </span>seek_scanline = |_d: <span class="kw-2">&amp;mut </span>MockDecoder, n: u64| -&gt; io::Result&lt;()&gt; {
seeks += <span class="number">1</span>;
<span class="macro">assert_eq!</span>(n, <span class="number">0</span>);
<span class="macro">assert_eq!</span>(seeks, <span class="number">1</span>);
<span class="prelude-val">Ok</span>(())
};
<span class="kw">fn </span>read_scanline(_m: <span class="kw-2">&amp;mut </span>MockDecoder, buf: <span class="kw-2">&amp;mut </span>[u8]) -&gt; io::Result&lt;()&gt; {
buf.copy_from_slice(<span class="kw-2">&amp;</span>DATA);
<span class="prelude-val">Ok</span>(())
}
<span class="kw">let </span><span class="kw-2">mut </span>output = [<span class="number">0</span>; <span class="number">26</span>];
load_rect(<span class="number">1</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">4</span>, <span class="kw-2">&amp;mut </span>output, |<span class="kw">_</span>|{},
<span class="kw-2">&amp;mut </span>MockDecoder,
seek_scanline, read_scanline).unwrap();
<span class="macro">assert_eq!</span>(output[<span class="number">0</span>..<span class="number">9</span>], [<span class="number">6</span>, <span class="number">7</span>, <span class="number">11</span>, <span class="number">12</span>, <span class="number">16</span>, <span class="number">17</span>, <span class="number">21</span>, <span class="number">22</span>, <span class="number">0</span>]);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_image_format_from_path() {
<span class="kw">fn </span>from_path(s: <span class="kw-2">&amp;</span>str) -&gt; ImageResult&lt;ImageFormat&gt; {
ImageFormat::from_path(Path::new(s))
}
<span class="macro">assert_eq!</span>(from_path(<span class="string">&quot;./a.jpg&quot;</span>).unwrap(), ImageFormat::Jpeg);
<span class="macro">assert_eq!</span>(from_path(<span class="string">&quot;./a.jpeg&quot;</span>).unwrap(), ImageFormat::Jpeg);
<span class="macro">assert_eq!</span>(from_path(<span class="string">&quot;./a.JPEG&quot;</span>).unwrap(), ImageFormat::Jpeg);
<span class="macro">assert_eq!</span>(from_path(<span class="string">&quot;./a.pNg&quot;</span>).unwrap(), ImageFormat::Png);
<span class="macro">assert_eq!</span>(from_path(<span class="string">&quot;./a.gif&quot;</span>).unwrap(), ImageFormat::Gif);
<span class="macro">assert_eq!</span>(from_path(<span class="string">&quot;./a.webp&quot;</span>).unwrap(), ImageFormat::WebP);
<span class="macro">assert_eq!</span>(from_path(<span class="string">&quot;./a.tiFF&quot;</span>).unwrap(), ImageFormat::Tiff);
<span class="macro">assert_eq!</span>(from_path(<span class="string">&quot;./a.tif&quot;</span>).unwrap(), ImageFormat::Tiff);
<span class="macro">assert_eq!</span>(from_path(<span class="string">&quot;./a.tga&quot;</span>).unwrap(), ImageFormat::Tga);
<span class="macro">assert_eq!</span>(from_path(<span class="string">&quot;./a.dds&quot;</span>).unwrap(), ImageFormat::Dds);
<span class="macro">assert_eq!</span>(from_path(<span class="string">&quot;./a.bmp&quot;</span>).unwrap(), ImageFormat::Bmp);
<span class="macro">assert_eq!</span>(from_path(<span class="string">&quot;./a.Ico&quot;</span>).unwrap(), ImageFormat::Ico);
<span class="macro">assert_eq!</span>(from_path(<span class="string">&quot;./a.hdr&quot;</span>).unwrap(), ImageFormat::Hdr);
<span class="macro">assert_eq!</span>(from_path(<span class="string">&quot;./a.pbm&quot;</span>).unwrap(), ImageFormat::Pnm);
<span class="macro">assert_eq!</span>(from_path(<span class="string">&quot;./a.pAM&quot;</span>).unwrap(), ImageFormat::Pnm);
<span class="macro">assert_eq!</span>(from_path(<span class="string">&quot;./a.Ppm&quot;</span>).unwrap(), ImageFormat::Pnm);
<span class="macro">assert_eq!</span>(from_path(<span class="string">&quot;./a.pgm&quot;</span>).unwrap(), ImageFormat::Pnm);
<span class="macro">assert_eq!</span>(from_path(<span class="string">&quot;./a.AViF&quot;</span>).unwrap(), ImageFormat::Avif);
<span class="macro">assert!</span>(from_path(<span class="string">&quot;./a.txt&quot;</span>).is_err());
<span class="macro">assert!</span>(from_path(<span class="string">&quot;./a&quot;</span>).is_err());
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_generic_image_copy_within_oob() {
<span class="kw">let </span><span class="kw-2">mut </span>image: GrayImage = ImageBuffer::from_raw(<span class="number">4</span>, <span class="number">4</span>, <span class="macro">vec!</span>[<span class="number">0u8</span>; <span class="number">16</span>]).unwrap();
<span class="macro">assert!</span>(!image.sub_image(<span class="number">0</span>, <span class="number">0</span>, <span class="number">4</span>, <span class="number">4</span>).copy_within(Rect { x: <span class="number">0</span>, y: <span class="number">0</span>, width: <span class="number">5</span>, height: <span class="number">4 </span>}, <span class="number">0</span>, <span class="number">0</span>));
<span class="macro">assert!</span>(!image.sub_image(<span class="number">0</span>, <span class="number">0</span>, <span class="number">4</span>, <span class="number">4</span>).copy_within(Rect { x: <span class="number">0</span>, y: <span class="number">0</span>, width: <span class="number">4</span>, height: <span class="number">5 </span>}, <span class="number">0</span>, <span class="number">0</span>));
<span class="macro">assert!</span>(!image.sub_image(<span class="number">0</span>, <span class="number">0</span>, <span class="number">4</span>, <span class="number">4</span>).copy_within(Rect { x: <span class="number">1</span>, y: <span class="number">0</span>, width: <span class="number">4</span>, height: <span class="number">4 </span>}, <span class="number">0</span>, <span class="number">0</span>));
<span class="macro">assert!</span>(!image.sub_image(<span class="number">0</span>, <span class="number">0</span>, <span class="number">4</span>, <span class="number">4</span>).copy_within(Rect { x: <span class="number">0</span>, y: <span class="number">0</span>, width: <span class="number">4</span>, height: <span class="number">4 </span>}, <span class="number">1</span>, <span class="number">0</span>));
<span class="macro">assert!</span>(!image.sub_image(<span class="number">0</span>, <span class="number">0</span>, <span class="number">4</span>, <span class="number">4</span>).copy_within(Rect { x: <span class="number">0</span>, y: <span class="number">1</span>, width: <span class="number">4</span>, height: <span class="number">4 </span>}, <span class="number">0</span>, <span class="number">0</span>));
<span class="macro">assert!</span>(!image.sub_image(<span class="number">0</span>, <span class="number">0</span>, <span class="number">4</span>, <span class="number">4</span>).copy_within(Rect { x: <span class="number">0</span>, y: <span class="number">0</span>, width: <span class="number">4</span>, height: <span class="number">4 </span>}, <span class="number">0</span>, <span class="number">1</span>));
<span class="macro">assert!</span>(!image.sub_image(<span class="number">0</span>, <span class="number">0</span>, <span class="number">4</span>, <span class="number">4</span>).copy_within(Rect { x: <span class="number">1</span>, y: <span class="number">1</span>, width: <span class="number">4</span>, height: <span class="number">4 </span>}, <span class="number">0</span>, <span class="number">0</span>));
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_generic_image_copy_within_tl() {
<span class="kw">let </span>data = <span class="kw-2">&amp;</span>[
<span class="number">00</span>, <span class="number">01</span>, <span class="number">02</span>, <span class="number">03</span>,
<span class="number">04</span>, <span class="number">05</span>, <span class="number">06</span>, <span class="number">07</span>,
<span class="number">08</span>, <span class="number">09</span>, <span class="number">10</span>, <span class="number">11</span>,
<span class="number">12</span>, <span class="number">13</span>, <span class="number">14</span>, <span class="number">15
</span>];
<span class="kw">let </span>expected = [
<span class="number">00</span>, <span class="number">01</span>, <span class="number">02</span>, <span class="number">03</span>,
<span class="number">04</span>, <span class="number">00</span>, <span class="number">01</span>, <span class="number">02</span>,
<span class="number">08</span>, <span class="number">04</span>, <span class="number">05</span>, <span class="number">06</span>,
<span class="number">12</span>, <span class="number">08</span>, <span class="number">09</span>, <span class="number">10</span>,
];
<span class="kw">let </span><span class="kw-2">mut </span>image: GrayImage = ImageBuffer::from_raw(<span class="number">4</span>, <span class="number">4</span>, Vec::from(<span class="kw-2">&amp;</span>data[..])).unwrap();
<span class="macro">assert!</span>(image.sub_image(<span class="number">0</span>, <span class="number">0</span>, <span class="number">4</span>, <span class="number">4</span>).copy_within(Rect { x: <span class="number">0</span>, y: <span class="number">0</span>, width: <span class="number">3</span>, height: <span class="number">3 </span>}, <span class="number">1</span>, <span class="number">1</span>));
<span class="macro">assert_eq!</span>(<span class="kw-2">&amp;</span>image.into_raw(), <span class="kw-2">&amp;</span>expected);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_generic_image_copy_within_tr() {
<span class="kw">let </span>data = <span class="kw-2">&amp;</span>[
<span class="number">00</span>, <span class="number">01</span>, <span class="number">02</span>, <span class="number">03</span>,
<span class="number">04</span>, <span class="number">05</span>, <span class="number">06</span>, <span class="number">07</span>,
<span class="number">08</span>, <span class="number">09</span>, <span class="number">10</span>, <span class="number">11</span>,
<span class="number">12</span>, <span class="number">13</span>, <span class="number">14</span>, <span class="number">15
</span>];
<span class="kw">let </span>expected = [
<span class="number">00</span>, <span class="number">01</span>, <span class="number">02</span>, <span class="number">03</span>,
<span class="number">01</span>, <span class="number">02</span>, <span class="number">03</span>, <span class="number">07</span>,
<span class="number">05</span>, <span class="number">06</span>, <span class="number">07</span>, <span class="number">11</span>,
<span class="number">09</span>, <span class="number">10</span>, <span class="number">11</span>, <span class="number">15
</span>];
<span class="kw">let </span><span class="kw-2">mut </span>image: GrayImage = ImageBuffer::from_raw(<span class="number">4</span>, <span class="number">4</span>, Vec::from(<span class="kw-2">&amp;</span>data[..])).unwrap();
<span class="macro">assert!</span>(image.sub_image(<span class="number">0</span>, <span class="number">0</span>, <span class="number">4</span>, <span class="number">4</span>).copy_within(Rect { x: <span class="number">1</span>, y: <span class="number">0</span>, width: <span class="number">3</span>, height: <span class="number">3 </span>}, <span class="number">0</span>, <span class="number">1</span>));
<span class="macro">assert_eq!</span>(<span class="kw-2">&amp;</span>image.into_raw(), <span class="kw-2">&amp;</span>expected);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_generic_image_copy_within_bl() {
<span class="kw">let </span>data = <span class="kw-2">&amp;</span>[
<span class="number">00</span>, <span class="number">01</span>, <span class="number">02</span>, <span class="number">03</span>,
<span class="number">04</span>, <span class="number">05</span>, <span class="number">06</span>, <span class="number">07</span>,
<span class="number">08</span>, <span class="number">09</span>, <span class="number">10</span>, <span class="number">11</span>,
<span class="number">12</span>, <span class="number">13</span>, <span class="number">14</span>, <span class="number">15
</span>];
<span class="kw">let </span>expected = [
<span class="number">00</span>, <span class="number">04</span>, <span class="number">05</span>, <span class="number">06</span>,
<span class="number">04</span>, <span class="number">08</span>, <span class="number">09</span>, <span class="number">10</span>,
<span class="number">08</span>, <span class="number">12</span>, <span class="number">13</span>, <span class="number">14</span>,
<span class="number">12</span>, <span class="number">13</span>, <span class="number">14</span>, <span class="number">15
</span>];
<span class="kw">let </span><span class="kw-2">mut </span>image: GrayImage = ImageBuffer::from_raw(<span class="number">4</span>, <span class="number">4</span>, Vec::from(<span class="kw-2">&amp;</span>data[..])).unwrap();
<span class="macro">assert!</span>(image.sub_image(<span class="number">0</span>, <span class="number">0</span>, <span class="number">4</span>, <span class="number">4</span>).copy_within(Rect { x: <span class="number">0</span>, y: <span class="number">1</span>, width: <span class="number">3</span>, height: <span class="number">3 </span>}, <span class="number">1</span>, <span class="number">0</span>));
<span class="macro">assert_eq!</span>(<span class="kw-2">&amp;</span>image.into_raw(), <span class="kw-2">&amp;</span>expected);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_generic_image_copy_within_br() {
<span class="kw">let </span>data = <span class="kw-2">&amp;</span>[
<span class="number">00</span>, <span class="number">01</span>, <span class="number">02</span>, <span class="number">03</span>,
<span class="number">04</span>, <span class="number">05</span>, <span class="number">06</span>, <span class="number">07</span>,
<span class="number">08</span>, <span class="number">09</span>, <span class="number">10</span>, <span class="number">11</span>,
<span class="number">12</span>, <span class="number">13</span>, <span class="number">14</span>, <span class="number">15
</span>];
<span class="kw">let </span>expected = [
<span class="number">05</span>, <span class="number">06</span>, <span class="number">07</span>, <span class="number">03</span>,
<span class="number">09</span>, <span class="number">10</span>, <span class="number">11</span>, <span class="number">07</span>,
<span class="number">13</span>, <span class="number">14</span>, <span class="number">15</span>, <span class="number">11</span>,
<span class="number">12</span>, <span class="number">13</span>, <span class="number">14</span>, <span class="number">15
</span>];
<span class="kw">let </span><span class="kw-2">mut </span>image: GrayImage = ImageBuffer::from_raw(<span class="number">4</span>, <span class="number">4</span>, Vec::from(<span class="kw-2">&amp;</span>data[..])).unwrap();
<span class="macro">assert!</span>(image.sub_image(<span class="number">0</span>, <span class="number">0</span>, <span class="number">4</span>, <span class="number">4</span>).copy_within(Rect { x: <span class="number">1</span>, y: <span class="number">1</span>, width: <span class="number">3</span>, height: <span class="number">3 </span>}, <span class="number">0</span>, <span class="number">0</span>));
<span class="macro">assert_eq!</span>(<span class="kw-2">&amp;</span>image.into_raw(), <span class="kw-2">&amp;</span>expected);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>image_formats_are_recognized() {
<span class="kw">use </span>ImageFormat::<span class="kw-2">*</span>;
<span class="kw">const </span>ALL_FORMATS: <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>[ImageFormat] = <span class="kw-2">&amp;</span>[Avif, Png, Jpeg, Gif, WebP, Pnm, Tiff, Tga, Dds, Bmp, Ico, Hdr, Farbfeld];
<span class="kw">for </span><span class="kw-2">&amp;</span>format <span class="kw">in </span>ALL_FORMATS {
<span class="kw">let </span><span class="kw-2">mut </span>file = Path::new(<span class="string">&quot;file.nothing&quot;</span>).to_owned();
<span class="kw">for </span>ext <span class="kw">in </span>format.extensions_str() {
<span class="macro">assert!</span>(file.set_extension(ext));
<span class="kw">match </span>ImageFormat::from_path(<span class="kw-2">&amp;</span>file) {
<span class="prelude-val">Err</span>(<span class="kw">_</span>) =&gt; <span class="macro">panic!</span>(<span class="string">&quot;Path {} not recognized as {:?}&quot;</span>, file.display(), format),
<span class="prelude-val">Ok</span>(result) =&gt; <span class="macro">assert_eq!</span>(format, result),
}
}
}
}
}
</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>