<!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 to the Rust file `/home/mrh/.cargo/registry/src/github.com-1ecc6299db9ec823/image-0.21.2/./src/flat.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>flat.rs.html -- source</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../image/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="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>
<span id="1382">1382</span>
<span id="1383">1383</span>
<span id="1384">1384</span>
<span id="1385">1385</span>
<span id="1386">1386</span>
<span id="1387">1387</span>
<span id="1388">1388</span>
<span id="1389">1389</span>
<span id="1390">1390</span>
<span id="1391">1391</span>
<span id="1392">1392</span>
<span id="1393">1393</span>
<span id="1394">1394</span>
<span id="1395">1395</span>
<span id="1396">1396</span>
<span id="1397">1397</span>
<span id="1398">1398</span>
<span id="1399">1399</span>
<span id="1400">1400</span>
<span id="1401">1401</span>
<span id="1402">1402</span>
<span id="1403">1403</span>
<span id="1404">1404</span>
<span id="1405">1405</span>
<span id="1406">1406</span>
<span id="1407">1407</span>
<span id="1408">1408</span>
<span id="1409">1409</span>
<span id="1410">1410</span>
<span id="1411">1411</span>
<span id="1412">1412</span>
<span id="1413">1413</span>
<span id="1414">1414</span>
<span id="1415">1415</span>
<span id="1416">1416</span>
<span id="1417">1417</span>
<span id="1418">1418</span>
<span id="1419">1419</span>
<span id="1420">1420</span>
<span id="1421">1421</span>
<span id="1422">1422</span>
<span id="1423">1423</span>
<span id="1424">1424</span>
<span id="1425">1425</span>
<span id="1426">1426</span>
<span id="1427">1427</span>
<span id="1428">1428</span>
<span id="1429">1429</span>
<span id="1430">1430</span>
<span id="1431">1431</span>
<span id="1432">1432</span>
<span id="1433">1433</span>
<span id="1434">1434</span>
<span id="1435">1435</span>
<span id="1436">1436</span>
<span id="1437">1437</span>
<span id="1438">1438</span>
<span id="1439">1439</span>
<span id="1440">1440</span>
<span id="1441">1441</span>
<span id="1442">1442</span>
<span id="1443">1443</span>
<span id="1444">1444</span>
<span id="1445">1445</span>
<span id="1446">1446</span>
<span id="1447">1447</span>
<span id="1448">1448</span>
<span id="1449">1449</span>
<span id="1450">1450</span>
<span id="1451">1451</span>
<span id="1452">1452</span>
<span id="1453">1453</span>
<span id="1454">1454</span>
<span id="1455">1455</span>
<span id="1456">1456</span>
<span id="1457">1457</span>
<span id="1458">1458</span>
<span id="1459">1459</span>
<span id="1460">1460</span>
<span id="1461">1461</span>
<span id="1462">1462</span>
<span id="1463">1463</span>
<span id="1464">1464</span>
<span id="1465">1465</span>
<span id="1466">1466</span>
<span id="1467">1467</span>
<span id="1468">1468</span>
<span id="1469">1469</span>
<span id="1470">1470</span>
<span id="1471">1471</span>
<span id="1472">1472</span>
<span id="1473">1473</span>
<span id="1474">1474</span>
<span id="1475">1475</span>
<span id="1476">1476</span>
<span id="1477">1477</span>
<span id="1478">1478</span>
<span id="1479">1479</span>
<span id="1480">1480</span>
<span id="1481">1481</span>
<span id="1482">1482</span>
<span id="1483">1483</span>
<span id="1484">1484</span>
<span id="1485">1485</span>
<span id="1486">1486</span>
<span id="1487">1487</span>
<span id="1488">1488</span>
<span id="1489">1489</span>
<span id="1490">1490</span>
<span id="1491">1491</span>
<span id="1492">1492</span>
<span id="1493">1493</span>
<span id="1494">1494</span>
<span id="1495">1495</span>
<span id="1496">1496</span>
<span id="1497">1497</span>
<span id="1498">1498</span>
<span id="1499">1499</span>
<span id="1500">1500</span>
<span id="1501">1501</span>
<span id="1502">1502</span>
<span id="1503">1503</span>
<span id="1504">1504</span>
<span id="1505">1505</span>
<span id="1506">1506</span>
<span id="1507">1507</span>
<span id="1508">1508</span>
<span id="1509">1509</span>
<span id="1510">1510</span>
<span id="1511">1511</span>
<span id="1512">1512</span>
<span id="1513">1513</span>
<span id="1514">1514</span>
<span id="1515">1515</span>
<span id="1516">1516</span>
<span id="1517">1517</span>
<span id="1518">1518</span>
<span id="1519">1519</span>
<span id="1520">1520</span>
<span id="1521">1521</span>
<span id="1522">1522</span>
<span id="1523">1523</span>
<span id="1524">1524</span>
<span id="1525">1525</span>
<span id="1526">1526</span>
<span id="1527">1527</span>
<span id="1528">1528</span>
<span id="1529">1529</span>
<span id="1530">1530</span>
<span id="1531">1531</span>
<span id="1532">1532</span>
<span id="1533">1533</span>
<span id="1534">1534</span>
<span id="1535">1535</span>
<span id="1536">1536</span>
<span id="1537">1537</span>
<span id="1538">1538</span>
<span id="1539">1539</span>
<span id="1540">1540</span>
<span id="1541">1541</span>
<span id="1542">1542</span>
<span id="1543">1543</span>
<span id="1544">1544</span>
<span id="1545">1545</span>
<span id="1546">1546</span>
<span id="1547">1547</span>
<span id="1548">1548</span>
<span id="1549">1549</span>
<span id="1550">1550</span>
<span id="1551">1551</span>
</pre><div class="example-wrap"><pre class="rust ">
<span class="doccomment">//! Image representations for ffi.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! # Usage</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Imagine you want to offer a very simple ffi interface: The caller provides an image buffer and</span>
<span class="doccomment">//! your program creates a thumbnail from it and dumps that image as `png`. This module is designed</span>
<span class="doccomment">//! to help you transition from raw memory data to Rust representation.</span>
<span class="doccomment">//! </span>
<span class="doccomment">//! ```no_run</span>
<span class="doccomment">//! use std::ptr;</span>
<span class="doccomment">//! use std::slice;</span>
<span class="doccomment">//! use image::Rgb;</span>
<span class="doccomment">//! use image::flat::{FlatSamples, SampleLayout};</span>
<span class="doccomment">//! use image::imageops::thumbnail;</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! #[no_mangle]</span>
<span class="doccomment">//! pub extern "C" fn store_rgb8_compressed(</span>
<span class="doccomment">//! data: *const u8, len: usize,</span>
<span class="doccomment">//! layout: *const SampleLayout</span>
<span class="doccomment">//! )</span>
<span class="doccomment">//! -> bool</span>
<span class="doccomment">//! {</span>
<span class="doccomment">//! let samples = unsafe { slice::from_raw_parts(data, len) };</span>
<span class="doccomment">//! let layout = unsafe { ptr::read(layout) };</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! let buffer = FlatSamples {</span>
<span class="doccomment">//! samples,</span>
<span class="doccomment">//! layout,</span>
<span class="doccomment">//! color_hint: None,</span>
<span class="doccomment">//! };</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! let view = match buffer.as_view::<Rgb<u8>>() {</span>
<span class="doccomment">//! Err(_) => return false, // Invalid layout.</span>
<span class="doccomment">//! Ok(view) => view,</span>
<span class="doccomment">//! };</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! thumbnail(&view, 64, 64)</span>
<span class="doccomment">//! .save("output.png")</span>
<span class="doccomment">//! .map(|_| true)</span>
<span class="doccomment">//! .unwrap_or_else(|_| false)</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//! </span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">cmp</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ops</span>::{<span class="ident">Deref</span>, <span class="ident">Index</span>, <span class="ident">IndexMut</span>};
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">marker</span>::<span class="ident">PhantomData</span>;
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">Zero</span>;
<span class="kw">use</span> <span class="ident">buffer</span>::{<span class="ident">ImageBuffer</span>, <span class="ident">Pixel</span>};
<span class="kw">use</span> <span class="ident">color</span>::<span class="ident">ColorType</span>;
<span class="kw">use</span> <span class="ident">image</span>::{<span class="ident">GenericImage</span>, <span class="ident">GenericImageView</span>, <span class="ident">ImageError</span>};
<span class="doccomment">/// A flat buffer over a (multi channel) image.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// In contrast to `ImageBuffer`, this representation of a sample collection is much more lenient</span>
<span class="doccomment">/// in the layout thereof. In particular, it also allows grouping by color planes instead of by</span>
<span class="doccomment">/// pixel, at least for the purpose of a `GenericImageView`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that the strides need not conform to the assumption that constructed indices actually</span>
<span class="doccomment">/// refer inside the underlying buffer but return values of library functions will always guarantee</span>
<span class="doccomment">/// this. To manually make this check use `check_index_validities` and maybe put that inside an</span>
<span class="doccomment">/// assert.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Debug</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">FlatSamples</span><span class="op"><</span><span class="ident">Buffer</span><span class="op">></span> {
<span class="doccomment">/// Underlying linear container holding sample values.</span>
<span class="kw">pub</span> <span class="ident">samples</span>: <span class="ident">Buffer</span>,
<span class="doccomment">/// A `repr(C)` description of the layout of buffer samples.</span>
<span class="kw">pub</span> <span class="ident">layout</span>: <span class="ident">SampleLayout</span>,
<span class="doccomment">/// Supplementary color information.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// You may keep this as `None` in most cases. This is NOT checked in `View` or other</span>
<span class="doccomment">/// converters. It is intended mainly as a way for types that convert to this buffer type to</span>
<span class="doccomment">/// attach their otherwise static color information. A dynamic image representation could</span>
<span class="doccomment">/// however use this to resolve representational ambiguities such as the order of RGB channels.</span>
<span class="kw">pub</span> <span class="ident">color_hint</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">ColorType</span><span class="op">></span>,
}
<span class="doccomment">/// A ffi compatible description of a sample buffer.</span>
<span class="attribute">#[<span class="ident">repr</span>(<span class="ident">C</span>)]</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Copy</span>, <span class="ident">Debug</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>, <span class="ident">Hash</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">SampleLayout</span> {
<span class="doccomment">/// The number of channels in the color representation of the image.</span>
<span class="kw">pub</span> <span class="ident">channels</span>: <span class="ident">u8</span>,
<span class="doccomment">/// Add this to an index to get to the sample in the next channel.</span>
<span class="kw">pub</span> <span class="ident">channel_stride</span>: <span class="ident">usize</span>,
<span class="doccomment">/// The width of the represented image.</span>
<span class="kw">pub</span> <span class="ident">width</span>: <span class="ident">u32</span>,
<span class="doccomment">/// Add this to an index to get to the next sample in x-direction.</span>
<span class="kw">pub</span> <span class="ident">width_stride</span>: <span class="ident">usize</span>,
<span class="doccomment">/// The height of the represented image.</span>
<span class="kw">pub</span> <span class="ident">height</span>: <span class="ident">u32</span>,
<span class="doccomment">/// Add this to an index to get to the next sample in y-direction.</span>
<span class="kw">pub</span> <span class="ident">height_stride</span>: <span class="ident">usize</span>,
}
<span class="doccomment">/// Helper struct for an unnamed (stride, length) pair.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Copy</span>, <span class="ident">Debug</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>, <span class="ident">PartialOrd</span>, <span class="ident">Ord</span>)]</span>
<span class="kw">struct</span> <span class="ident">Dim</span>(<span class="ident">usize</span>, <span class="ident">usize</span>);
<span class="kw">impl</span> <span class="ident">SampleLayout</span> {
<span class="doccomment">/// Describe a row-major image packed in all directions.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The resulting will surely be `NormalForm::RowMajorPacked`. It can therefore be converted to</span>
<span class="doccomment">/// safely to an `ImageBuffer` with a large enough underlying buffer.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// # use image::flat::{NormalForm, SampleLayout};</span>
<span class="doccomment">/// let layout = SampleLayout::row_major_packed(3, 640, 480);</span>
<span class="doccomment">/// assert!(layout.is_normal(NormalForm::RowMajorPacked));</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Panics</span>
<span class="doccomment">///</span>
<span class="doccomment">/// On platforms where `usize` has the same size as `u32` this panics when the resulting stride</span>
<span class="doccomment">/// in the `height` direction would be larger than `usize::max_value()`. On other platforms</span>
<span class="doccomment">/// where it can surely accomodate `u8::max_value() * u32::max_value(), this can never happen.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">row_major_packed</span>(<span class="ident">channels</span>: <span class="ident">u8</span>, <span class="ident">width</span>: <span class="ident">u32</span>, <span class="ident">height</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
<span class="kw">let</span> <span class="ident">height_stride</span> <span class="op">=</span> (<span class="ident">channels</span> <span class="kw">as</span> <span class="ident">usize</span>).<span class="ident">checked_mul</span>(<span class="ident">width</span> <span class="kw">as</span> <span class="ident">usize</span>)
.<span class="ident">expect</span>(<span class="string">"Row major packed image can not be described because it does not fit into memory"</span>);
<span class="ident">SampleLayout</span> {
<span class="ident">channels</span>,
<span class="ident">channel_stride</span>: <span class="number">1</span>,
<span class="ident">width</span>,
<span class="ident">width_stride</span>: <span class="ident">channels</span> <span class="kw">as</span> <span class="ident">usize</span>,
<span class="ident">height</span>,
<span class="ident">height_stride</span>,
}
}
<span class="doccomment">/// Describe a column-major image packed in all directions.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The resulting will surely be `NormalForm::ColumnMajorPacked`. This is not particularly</span>
<span class="doccomment">/// useful for conversion but can be used to describe such a buffer without pitfalls.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// # use image::flat::{NormalForm, SampleLayout};</span>
<span class="doccomment">/// let layout = SampleLayout::column_major_packed(3, 640, 480);</span>
<span class="doccomment">/// assert!(layout.is_normal(NormalForm::ColumnMajorPacked));</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Panics</span>
<span class="doccomment">///</span>
<span class="doccomment">/// On platforms where `usize` has the same size as `u32` this panics when the resulting stride</span>
<span class="doccomment">/// in the `width` direction would be larger than `usize::max_value()`. On other platforms</span>
<span class="doccomment">/// where it can surely accomodate `u8::max_value() * u32::max_value(), this can never happen.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">column_major_packed</span>(<span class="ident">channels</span>: <span class="ident">u8</span>, <span class="ident">width</span>: <span class="ident">u32</span>, <span class="ident">height</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
<span class="kw">let</span> <span class="ident">width_stride</span> <span class="op">=</span> (<span class="ident">channels</span> <span class="kw">as</span> <span class="ident">usize</span>).<span class="ident">checked_mul</span>(<span class="ident">height</span> <span class="kw">as</span> <span class="ident">usize</span>)
.<span class="ident">expect</span>(<span class="string">"Column major packed image can not be described because it does not fit into memory"</span>);
<span class="ident">SampleLayout</span> {
<span class="ident">channels</span>,
<span class="ident">channel_stride</span>: <span class="number">1</span>,
<span class="ident">height</span>,
<span class="ident">height_stride</span>: <span class="ident">channels</span> <span class="kw">as</span> <span class="ident">usize</span>,
<span class="ident">width</span>,
<span class="ident">width_stride</span>,
}
}
<span class="doccomment">/// Get the strides for indexing matrix-like `[(c, w, h)]`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// For a row-major layout with grouped samples, this tuple is strictly</span>
<span class="doccomment">/// increasing.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">strides_cwh</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> (<span class="ident">usize</span>, <span class="ident">usize</span>, <span class="ident">usize</span>) {
(<span class="self">self</span>.<span class="ident">channel_stride</span>, <span class="self">self</span>.<span class="ident">width_stride</span>, <span class="self">self</span>.<span class="ident">height_stride</span>)
}
<span class="doccomment">/// Get the dimensions `(channels, width, height)`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The interface is optimized for use with `strides_cwh` instead. The channel extent will be</span>
<span class="doccomment">/// before width and height.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">extents</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> (<span class="ident">usize</span>, <span class="ident">usize</span>, <span class="ident">usize</span>) {
(<span class="self">self</span>.<span class="ident">channels</span> <span class="kw">as</span> <span class="ident">usize</span>, <span class="self">self</span>.<span class="ident">width</span> <span class="kw">as</span> <span class="ident">usize</span>, <span class="self">self</span>.<span class="ident">height</span> <span class="kw">as</span> <span class="ident">usize</span>)
}
<span class="doccomment">/// Tuple of bounds in the order of coordinate inputs.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This function should be used whenever working with image coordinates opposed to buffer</span>
<span class="doccomment">/// coordinates. The only difference compared to `extents` is the output type.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">bounds</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> (<span class="ident">u8</span>, <span class="ident">u32</span>, <span class="ident">u32</span>) {
(<span class="self">self</span>.<span class="ident">channels</span>, <span class="self">self</span>.<span class="ident">width</span>, <span class="self">self</span>.<span class="ident">height</span>)
}
<span class="doccomment">/// Get the minimum length of a buffer such that all in-bounds samples have valid indices.</span>
<span class="doccomment">/// </span>
<span class="doccomment">/// This method will allow zero strides, allowing compact representations of monochrome images.</span>
<span class="doccomment">/// To check that no aliasing occurs, try `check_alias_invariants`. For compact images (no</span>
<span class="doccomment">/// aliasing and no unindexed samples) this is `width*height*channels`. But for both of the</span>
<span class="doccomment">/// other cases, the reasoning is slightly more involved.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Explanation</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that there is a difference between `min_length` and the index of the sample</span>
<span class="doccomment">/// 'one-past-the-end`. This is due to strides that may be larger than the dimension below.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ## Example with holes</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Let's look at an example of a grayscale image with </span>
<span class="doccomment">/// * `width_stride = 1`</span>
<span class="doccomment">/// * `width = 2`</span>
<span class="doccomment">/// * `height_stride = 3`</span>
<span class="doccomment">/// * `height = 2`</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```text</span>
<span class="doccomment">/// | x x | x x m | $</span>
<span class="doccomment">/// min_length m ^</span>
<span class="doccomment">/// ^ one-past-the-end $</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The difference is also extreme for empty images with large strides. The one-past-the-end</span>
<span class="doccomment">/// sample index is still as large as the largest of these strides while `min_length = 0`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ## Example with aliasing</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The concept gets even more important when you allow samples to alias each other. Here we</span>
<span class="doccomment">/// have the buffer of a small grayscale image where this is the case, this time we will first</span>
<span class="doccomment">/// show the buffer and then the individual rows below.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// * `width_stride = 1`</span>
<span class="doccomment">/// * `width = 3`</span>
<span class="doccomment">/// * `height_stride = 2`</span>
<span class="doccomment">/// * `height = 2`</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```text</span>
<span class="doccomment">/// 1 2 3 4 5 m</span>
<span class="doccomment">/// |1 2 3| row one</span>
<span class="doccomment">/// |3 4 5| row two</span>
<span class="doccomment">/// ^ m min_length</span>
<span class="doccomment">/// ^ ??? one-past-the-end</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This time 'one-past-the-end' is not even simply the largest stride times the extent of its</span>
<span class="doccomment">/// dimension. That still points inside the image because `height*height_stride = 4` but also</span>
<span class="doccomment">/// `index_of(1, 2) = 4`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">min_length</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span> {
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">width</span> <span class="op">=</span><span class="op">=</span> <span class="number">0</span> <span class="op">|</span><span class="op">|</span> <span class="self">self</span>.<span class="ident">height</span> <span class="op">=</span><span class="op">=</span> <span class="number">0</span> <span class="op">|</span><span class="op">|</span> <span class="self">self</span>.<span class="ident">channels</span> <span class="op">=</span><span class="op">=</span> <span class="number">0</span> {
<span class="kw">return</span> <span class="prelude-val">Some</span>(<span class="number">0</span>)
}
<span class="self">self</span>.<span class="ident">index</span>(<span class="self">self</span>.<span class="ident">channels</span> <span class="op">-</span> <span class="number">1</span>, <span class="self">self</span>.<span class="ident">width</span> <span class="op">-</span> <span class="number">1</span>, <span class="self">self</span>.<span class="ident">height</span> <span class="op">-</span> <span class="number">1</span>)
.<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">idx</span><span class="op">|</span> <span class="ident">idx</span>.<span class="ident">checked_add</span>(<span class="number">1</span>))
}
<span class="doccomment">/// Check if a buffer of length `len` is large enough.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">fits</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">len</span>: <span class="ident">usize</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> {
<span class="self">self</span>.<span class="ident">min_length</span>().<span class="ident">map</span>(<span class="op">|</span><span class="ident">min</span><span class="op">|</span> <span class="ident">len</span> <span class="op">></span><span class="op">=</span> <span class="ident">min</span>).<span class="ident">unwrap_or</span>(<span class="bool-val">false</span>)
}
<span class="doccomment">/// The extents of this array, in order of increasing strides.</span>
<span class="kw">fn</span> <span class="ident">increasing_stride_dims</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> [<span class="ident">Dim</span>; <span class="number">3</span>] {
<span class="comment">// Order extents by strides, then check that each is less equal than the next stride.</span>
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">grouped</span>: [<span class="ident">Dim</span>; <span class="number">3</span>] <span class="op">=</span> [
<span class="ident">Dim</span>(<span class="self">self</span>.<span class="ident">channel_stride</span>, <span class="self">self</span>.<span class="ident">channels</span> <span class="kw">as</span> <span class="ident">usize</span>),
<span class="ident">Dim</span>(<span class="self">self</span>.<span class="ident">width_stride</span>, <span class="self">self</span>.<span class="ident">width</span> <span class="kw">as</span> <span class="ident">usize</span>),
<span class="ident">Dim</span>(<span class="self">self</span>.<span class="ident">height_stride</span>, <span class="self">self</span>.<span class="ident">height</span> <span class="kw">as</span> <span class="ident">usize</span>)];
<span class="ident">grouped</span>.<span class="ident">sort</span>();
<span class="kw">let</span> (<span class="ident">min_dim</span>, <span class="ident">mid_dim</span>, <span class="ident">max_dim</span>) <span class="op">=</span> (<span class="ident">grouped</span>[<span class="number">0</span>], <span class="ident">grouped</span>[<span class="number">1</span>], <span class="ident">grouped</span>[<span class="number">2</span>]);
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">min_dim</span>.<span class="ident">stride</span>() <span class="op"><</span><span class="op">=</span> <span class="ident">mid_dim</span>.<span class="ident">stride</span>() <span class="kw-2">&</span><span class="op">&</span> <span class="ident">mid_dim</span>.<span class="ident">stride</span>() <span class="op"><</span><span class="op">=</span> <span class="ident">max_dim</span>.<span class="ident">stride</span>());
<span class="ident">grouped</span>
}
<span class="doccomment">/// If there are any samples aliasing each other.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If this is not the case, it would always be safe to allow mutable access to two different</span>
<span class="doccomment">/// samples at the same time. Otherwise, this operation would need additional checks. When one</span>
<span class="doccomment">/// dimension overflows `usize` with its stride we also consider this aliasing.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">has_aliased_samples</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> {
<span class="kw">let</span> <span class="ident">grouped</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">increasing_stride_dims</span>();
<span class="kw">let</span> (<span class="ident">min_dim</span>, <span class="ident">mid_dim</span>, <span class="ident">max_dim</span>) <span class="op">=</span> (<span class="ident">grouped</span>[<span class="number">0</span>], <span class="ident">grouped</span>[<span class="number">1</span>], <span class="ident">grouped</span>[<span class="number">2</span>]);
<span class="kw">let</span> <span class="ident">min_size</span> <span class="op">=</span> <span class="kw">match</span> <span class="ident">min_dim</span>.<span class="ident">checked_len</span>() {
<span class="prelude-val">None</span> <span class="op">=</span><span class="op">></span> <span class="kw">return</span> <span class="bool-val">true</span>,
<span class="prelude-val">Some</span>(<span class="ident">size</span>) <span class="op">=</span><span class="op">></span> <span class="ident">size</span>,
};
<span class="kw">let</span> <span class="ident">mid_size</span> <span class="op">=</span> <span class="kw">match</span> <span class="ident">mid_dim</span>.<span class="ident">checked_len</span>() {
<span class="prelude-val">None</span> <span class="op">=</span><span class="op">></span> <span class="kw">return</span> <span class="bool-val">true</span>,
<span class="prelude-val">Some</span>(<span class="ident">size</span>) <span class="op">=</span><span class="op">></span> <span class="ident">size</span>,
};
<span class="kw">let</span> <span class="ident">_max_size</span> <span class="op">=</span> <span class="kw">match</span> <span class="ident">max_dim</span>.<span class="ident">checked_len</span>() {
<span class="prelude-val">None</span> <span class="op">=</span><span class="op">></span> <span class="kw">return</span> <span class="bool-val">true</span>,
<span class="prelude-val">Some</span>(<span class="kw">_</span>) <span class="op">=</span><span class="op">></span> (), <span class="comment">// Only want to know this didn't overflow.</span>
};
<span class="comment">// Each higher dimension must walk over all of one lower dimension.</span>
<span class="ident">min_size</span> <span class="op">></span> <span class="ident">mid_dim</span>.<span class="ident">stride</span>() <span class="op">|</span><span class="op">|</span> <span class="ident">mid_size</span> <span class="op">></span> <span class="ident">max_dim</span>.<span class="ident">stride</span>()
}
<span class="doccomment">/// Check if a buffer fulfills the requirements of a normal form.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Certain conversions have preconditions on the structure of the sample buffer that are not</span>
<span class="doccomment">/// captured (by design) by the type system. These are then checked before the conversion. Such</span>
<span class="doccomment">/// checks can all be done in constant time and will not inspect the buffer content. You can</span>
<span class="doccomment">/// perform these checks yourself when the conversion is not required at this moment but maybe</span>
<span class="doccomment">/// still performed later.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">is_normal</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">form</span>: <span class="ident">NormalForm</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> {
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">has_aliased_samples</span>() {
<span class="kw">return</span> <span class="bool-val">false</span>;
}
<span class="kw">if</span> <span class="ident">form</span> <span class="op">></span><span class="op">=</span> <span class="ident">NormalForm</span>::<span class="ident">PixelPacked</span> <span class="kw-2">&</span><span class="op">&</span> <span class="self">self</span>.<span class="ident">channel_stride</span> <span class="op">!</span><span class="op">=</span> <span class="number">1</span> {
<span class="kw">return</span> <span class="bool-val">false</span>;
}
<span class="kw">if</span> <span class="ident">form</span> <span class="op">></span><span class="op">=</span> <span class="ident">NormalForm</span>::<span class="ident">ImagePacked</span> {
<span class="comment">// has aliased already checked for overflows.</span>
<span class="kw">let</span> <span class="ident">grouped</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">increasing_stride_dims</span>();
<span class="kw">let</span> (<span class="ident">min_dim</span>, <span class="ident">mid_dim</span>, <span class="ident">max_dim</span>) <span class="op">=</span> (<span class="ident">grouped</span>[<span class="number">0</span>], <span class="ident">grouped</span>[<span class="number">1</span>], <span class="ident">grouped</span>[<span class="number">2</span>]);
<span class="kw">if</span> <span class="number">1</span> <span class="op">!</span><span class="op">=</span> <span class="ident">min_dim</span>.<span class="ident">stride</span>() {
<span class="kw">return</span> <span class="bool-val">false</span>;
}
<span class="kw">if</span> <span class="ident">min_dim</span>.<span class="ident">len</span>() <span class="op">!</span><span class="op">=</span> <span class="ident">mid_dim</span>.<span class="ident">stride</span>() {
<span class="kw">return</span> <span class="bool-val">false</span>;
}
<span class="kw">if</span> <span class="ident">mid_dim</span>.<span class="ident">len</span>() <span class="op">!</span><span class="op">=</span> <span class="ident">max_dim</span>.<span class="ident">stride</span>() {
<span class="kw">return</span> <span class="bool-val">false</span>;
}
}
<span class="kw">if</span> <span class="ident">form</span> <span class="op">></span><span class="op">=</span> <span class="ident">NormalForm</span>::<span class="ident">RowMajorPacked</span> {
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">width_stride</span> <span class="op">!</span><span class="op">=</span> <span class="self">self</span>.<span class="ident">channels</span> <span class="kw">as</span> <span class="ident">usize</span> {
<span class="kw">return</span> <span class="bool-val">false</span>;
}
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">width</span> <span class="kw">as</span> <span class="ident">usize</span><span class="kw-2">*</span><span class="self">self</span>.<span class="ident">width_stride</span> <span class="op">!</span><span class="op">=</span> <span class="self">self</span>.<span class="ident">height_stride</span> {
<span class="kw">return</span> <span class="bool-val">false</span>;
}
}
<span class="kw">if</span> <span class="ident">form</span> <span class="op">></span><span class="op">=</span> <span class="ident">NormalForm</span>::<span class="ident">ColumnMajorPacked</span> {
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">height_stride</span> <span class="op">!</span><span class="op">=</span> <span class="self">self</span>.<span class="ident">channels</span> <span class="kw">as</span> <span class="ident">usize</span> {
<span class="kw">return</span> <span class="bool-val">false</span>;
}
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">height</span> <span class="kw">as</span> <span class="ident">usize</span><span class="kw-2">*</span><span class="self">self</span>.<span class="ident">height_stride</span> <span class="op">!</span><span class="op">=</span> <span class="self">self</span>.<span class="ident">width_stride</span> {
<span class="kw">return</span> <span class="bool-val">false</span>;
}
}
<span class="kw">return</span> <span class="bool-val">true</span>;
}
<span class="doccomment">/// Check that the pixel and the channel index are in bounds.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// An in-bound coordinate does not yet guarantee that the corresponding calculation of a</span>
<span class="doccomment">/// buffer index does not overflow. However, if such a buffer large enough to hold all samples</span>
<span class="doccomment">/// actually exists in memory, this porperty of course follows.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">in_bounds</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">channel</span>: <span class="ident">u8</span>, <span class="ident">x</span>: <span class="ident">u32</span>, <span class="ident">y</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> {
<span class="kw">return</span> <span class="ident">channel</span> <span class="op"><</span> <span class="self">self</span>.<span class="ident">channels</span> <span class="kw-2">&</span><span class="op">&</span> <span class="ident">x</span> <span class="op"><</span> <span class="self">self</span>.<span class="ident">width</span> <span class="kw-2">&</span><span class="op">&</span> <span class="ident">y</span> <span class="op"><</span> <span class="self">self</span>.<span class="ident">height</span>
}
<span class="doccomment">/// Resolve the index of a particular sample.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// `None` if the index is outside the bounds or does not fit into a `usize`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">index</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">channel</span>: <span class="ident">u8</span>, <span class="ident">x</span>: <span class="ident">u32</span>, <span class="ident">y</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span> {
<span class="kw">if</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">in_bounds</span>(<span class="ident">channel</span>, <span class="ident">x</span>, <span class="ident">y</span>) {
<span class="kw">return</span> <span class="prelude-val">None</span>
}
<span class="self">self</span>.<span class="ident">index_ignoring_bounds</span>(<span class="ident">channel</span> <span class="kw">as</span> <span class="ident">usize</span>, <span class="ident">x</span> <span class="kw">as</span> <span class="ident">usize</span>, <span class="ident">y</span> <span class="kw">as</span> <span class="ident">usize</span>)
}
<span class="doccomment">/// Get the theoretical position of sample (channel, x, y).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The 'check' is for overflow during index calculation, not that it is contained in the</span>
<span class="doccomment">/// image. Two samples may return the same index, even when one of them is out of bounds. This</span>
<span class="doccomment">/// happens when all strides are `0`, i.e. the image is an arbitrarily large monochrome image.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">index_ignoring_bounds</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">channel</span>: <span class="ident">usize</span>, <span class="ident">x</span>: <span class="ident">usize</span>, <span class="ident">y</span>: <span class="ident">usize</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span> {
<span class="kw">let</span> <span class="ident">idx_c</span> <span class="op">=</span> (<span class="ident">channel</span> <span class="kw">as</span> <span class="ident">usize</span>).<span class="ident">checked_mul</span>(<span class="self">self</span>.<span class="ident">channel_stride</span>);
<span class="kw">let</span> <span class="ident">idx_x</span> <span class="op">=</span> (<span class="ident">x</span> <span class="kw">as</span> <span class="ident">usize</span>).<span class="ident">checked_mul</span>(<span class="self">self</span>.<span class="ident">width_stride</span>);
<span class="kw">let</span> <span class="ident">idx_y</span> <span class="op">=</span> (<span class="ident">y</span> <span class="kw">as</span> <span class="ident">usize</span>).<span class="ident">checked_mul</span>(<span class="self">self</span>.<span class="ident">height_stride</span>);
<span class="kw">let</span> (<span class="ident">idx_c</span>, <span class="ident">idx_x</span>, <span class="ident">idx_y</span>) <span class="op">=</span> <span class="kw">match</span> (<span class="ident">idx_c</span>, <span class="ident">idx_x</span>, <span class="ident">idx_y</span>) {
(<span class="prelude-val">Some</span>(<span class="ident">idx_c</span>), <span class="prelude-val">Some</span>(<span class="ident">idx_x</span>), <span class="prelude-val">Some</span>(<span class="ident">idx_y</span>)) <span class="op">=</span><span class="op">></span> (<span class="ident">idx_c</span>, <span class="ident">idx_x</span>, <span class="ident">idx_y</span>),
<span class="kw">_</span> <span class="op">=</span><span class="op">></span> <span class="kw">return</span> <span class="prelude-val">None</span>,
};
<span class="prelude-val">Some</span>(<span class="number">0usize</span>)
.<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">b</span><span class="op">|</span> <span class="ident">b</span>.<span class="ident">checked_add</span>(<span class="ident">idx_c</span>))
.<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">b</span><span class="op">|</span> <span class="ident">b</span>.<span class="ident">checked_add</span>(<span class="ident">idx_x</span>))
.<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">b</span><span class="op">|</span> <span class="ident">b</span>.<span class="ident">checked_add</span>(<span class="ident">idx_y</span>))
}
<span class="doccomment">/// Get an index provided it is inbouds.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Assumes that the image is backed by some sufficiently large buffer. Then computation can</span>
<span class="doccomment">/// not overflow as we could represent the maximum coordinate. Since overflow is defined either</span>
<span class="doccomment">/// way, this method can not be unsafe.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">in_bounds_index</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">c</span>: <span class="ident">u8</span>, <span class="ident">x</span>: <span class="ident">u32</span>, <span class="ident">y</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">></span> <span class="ident">usize</span> {
<span class="kw">let</span> (<span class="ident">c_stride</span>, <span class="ident">x_stride</span>, <span class="ident">y_stride</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">strides_cwh</span>();
(<span class="ident">y</span> <span class="kw">as</span> <span class="ident">usize</span> <span class="op">*</span> <span class="ident">y_stride</span>) <span class="op">+</span> (<span class="ident">x</span> <span class="kw">as</span> <span class="ident">usize</span> <span class="op">*</span> <span class="ident">x_stride</span>) <span class="op">+</span> (<span class="ident">c</span> <span class="kw">as</span> <span class="ident">usize</span> <span class="op">*</span> <span class="ident">c_stride</span>)
}
<span class="doccomment">/// Shrink the image to the minimum of current and given extents.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This does not modify the strides, so that the resulting sample buffer may have holes</span>
<span class="doccomment">/// created by the shrinking operation. Shrinking could also lead to an non-aliasing image when</span>
<span class="doccomment">/// samples had aliased each other before.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">shrink_to</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">channels</span>: <span class="ident">u8</span>, <span class="ident">width</span>: <span class="ident">u32</span>, <span class="ident">height</span>: <span class="ident">u32</span>) {
<span class="self">self</span>.<span class="ident">channels</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">channels</span>.<span class="ident">min</span>(<span class="ident">channels</span>);
<span class="self">self</span>.<span class="ident">width</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">width</span>.<span class="ident">min</span>(<span class="ident">width</span>);
<span class="self">self</span>.<span class="ident">height</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">height</span>.<span class="ident">min</span>(<span class="ident">height</span>);
}
}
<span class="kw">impl</span> <span class="ident">Dim</span> {
<span class="kw">fn</span> <span class="ident">stride</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">usize</span> {
<span class="self">self</span>.<span class="number">0</span>
}
<span class="doccomment">/// Length of this dimension in memory.</span>
<span class="kw">fn</span> <span class="ident">checked_len</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span> {
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">checked_mul</span>(<span class="self">self</span>.<span class="number">1</span>)
}
<span class="kw">fn</span> <span class="ident">len</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">usize</span> {
<span class="self">self</span>.<span class="number">0</span><span class="kw-2">*</span><span class="self">self</span>.<span class="number">1</span>
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">Buffer</span><span class="op">></span> <span class="ident">FlatSamples</span><span class="op"><</span><span class="ident">Buffer</span><span class="op">></span> {
<span class="doccomment">/// Get the strides for indexing matrix-like `[(c, w, h)]`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// For a row-major layout with grouped samples, this tuple is strictly</span>
<span class="doccomment">/// increasing.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">strides_cwh</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> (<span class="ident">usize</span>, <span class="ident">usize</span>, <span class="ident">usize</span>) {
<span class="self">self</span>.<span class="ident">layout</span>.<span class="ident">strides_cwh</span>()
}
<span class="doccomment">/// Get the dimensions `(channels, width, height)`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The interface is optimized for use with `strides_cwh` instead. The channel extent will be</span>
<span class="doccomment">/// before width and height.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">extents</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> (<span class="ident">usize</span>, <span class="ident">usize</span>, <span class="ident">usize</span>) {
<span class="self">self</span>.<span class="ident">layout</span>.<span class="ident">extents</span>()
}
<span class="doccomment">/// Tuple of bounds in the order of coordinate inputs.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This function should be used whenever working with image coordinates opposed to buffer</span>
<span class="doccomment">/// coordinates. The only difference compared to `extents` is the output type.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">bounds</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> (<span class="ident">u8</span>, <span class="ident">u32</span>, <span class="ident">u32</span>) {
<span class="self">self</span>.<span class="ident">layout</span>.<span class="ident">bounds</span>()
}
<span class="doccomment">/// Get a reference based version.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">as_ref</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">FlatSamples</span><span class="op"><</span><span class="kw-2">&</span>[<span class="ident">T</span>]<span class="op">></span> <span class="kw">where</span> <span class="ident">Buffer</span>: <span class="ident">AsRef</span><span class="op"><</span>[<span class="ident">T</span>]<span class="op">></span> {
<span class="ident">FlatSamples</span> {
<span class="ident">samples</span>: <span class="self">self</span>.<span class="ident">samples</span>.<span class="ident">as_ref</span>(),
<span class="ident">layout</span>: <span class="self">self</span>.<span class="ident">layout</span>,
<span class="ident">color_hint</span>: <span class="self">self</span>.<span class="ident">color_hint</span>,
}
}
<span class="doccomment">/// Get a mutable reference based version.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">as_mut</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">FlatSamples</span><span class="op"><</span><span class="kw-2">&</span><span class="kw-2">mut</span> [<span class="ident">T</span>]<span class="op">></span> <span class="kw">where</span> <span class="ident">Buffer</span>: <span class="ident">AsMut</span><span class="op"><</span>[<span class="ident">T</span>]<span class="op">></span> {
<span class="ident">FlatSamples</span> {
<span class="ident">samples</span>: <span class="self">self</span>.<span class="ident">samples</span>.<span class="ident">as_mut</span>(),
<span class="ident">layout</span>: <span class="self">self</span>.<span class="ident">layout</span>,
<span class="ident">color_hint</span>: <span class="self">self</span>.<span class="ident">color_hint</span>,
}
}
<span class="doccomment">/// Copy the data into an owned vector.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">to_vec</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">FlatSamples</span><span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">T</span><span class="op">></span><span class="op">></span>
<span class="kw">where</span> <span class="ident">T</span>: <span class="ident">Clone</span>, <span class="ident">Buffer</span>: <span class="ident">AsRef</span><span class="op"><</span>[<span class="ident">T</span>]<span class="op">></span>
{
<span class="ident">FlatSamples</span> {
<span class="ident">samples</span>: <span class="self">self</span>.<span class="ident">samples</span>.<span class="ident">as_ref</span>().<span class="ident">to_vec</span>(),
<span class="ident">layout</span>: <span class="self">self</span>.<span class="ident">layout</span>,
<span class="ident">color_hint</span>: <span class="self">self</span>.<span class="ident">color_hint</span>,
}
}
<span class="doccomment">/// Get a reference to a single sample.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This more restrictive than the method based on `std::ops::Index` but guarantees to properly</span>
<span class="doccomment">/// check all bounds and not panic as long as `Buffer::as_ref` does not do so.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// # use image::{RgbImage};</span>
<span class="doccomment">/// let flat = RgbImage::new(480, 640).into_flat_samples(); </span>
<span class="doccomment">///</span>
<span class="doccomment">/// // Get the blue channel at (10, 10).</span>
<span class="doccomment">/// assert!(flat.get_sample(1, 10, 10).is_some());</span>
<span class="doccomment">///</span>
<span class="doccomment">/// // There is no alpha channel.</span>
<span class="doccomment">/// assert!(flat.get_sample(3, 10, 10).is_none());</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// For cases where a special buffer does not provide `AsRef<[T]>`, consider encapsulating</span>
<span class="doccomment">/// bounds checks with `min_length` in a type similar to `View`. Then you may use</span>
<span class="doccomment">/// `in_bounds_index` as a small speedup over the index calculation of this method which relies</span>
<span class="doccomment">/// on `index_ignoring_bounds` since it can not have a-priori knowledge that the sample</span>
<span class="doccomment">/// coordinate is in fact backed by any memory buffer.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_sample</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">channel</span>: <span class="ident">u8</span>, <span class="ident">x</span>: <span class="ident">u32</span>, <span class="ident">y</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">T</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">Buffer</span>: <span class="ident">AsRef</span><span class="op"><</span>[<span class="ident">T</span>]<span class="op">></span>,
{
<span class="self">self</span>.<span class="ident">index</span>(<span class="ident">channel</span>, <span class="ident">x</span>, <span class="ident">y</span>).<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">idx</span><span class="op">|</span> <span class="self">self</span>.<span class="ident">samples</span>.<span class="ident">as_ref</span>().<span class="ident">get</span>(<span class="ident">idx</span>))
}
<span class="doccomment">/// Get a mutable reference to a single sample.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This more restrictive than the method based on `std::ops::IndexMut` but guarantees to</span>
<span class="doccomment">/// properly check all bounds and not panic as long as `Buffer::as_ref` does not do so.</span>
<span class="doccomment">/// Contrary to conversion to `ViewMut`, this does not require that samples are packed since it</span>
<span class="doccomment">/// does not need to convert samples to a color representation.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// **WARNING**: Note that of course samples may alias, so that the mutable reference returned</span>
<span class="doccomment">/// here can in fact modify more than the coordinate in the argument.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// # use image::{RgbImage};</span>
<span class="doccomment">/// let mut flat = RgbImage::new(480, 640).into_flat_samples(); </span>
<span class="doccomment">///</span>
<span class="doccomment">/// // Assign some new color to the blue channel at (10, 10).</span>
<span class="doccomment">/// *flat.get_mut_sample(1, 10, 10).unwrap() = 255;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// // There is no alpha channel.</span>
<span class="doccomment">/// assert!(flat.get_mut_sample(3, 10, 10).is_none());</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// For cases where a special buffer does not provide `AsRef<[T]>`, consider encapsulating</span>
<span class="doccomment">/// bounds checks with `min_length` in a type similar to `View`. Then you may use</span>
<span class="doccomment">/// `in_bounds_index` as a small speedup over the index calculation of this method which relies</span>
<span class="doccomment">/// on `index_ignoring_bounds` since it can not have a-priori knowledge that the sample</span>
<span class="doccomment">/// coordinate is in fact backed by any memory buffer.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_mut_sample</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">channel</span>: <span class="ident">u8</span>, <span class="ident">x</span>: <span class="ident">u32</span>, <span class="ident">y</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">T</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">Buffer</span>: <span class="ident">AsMut</span><span class="op"><</span>[<span class="ident">T</span>]<span class="op">></span>,
{
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">index</span>(<span class="ident">channel</span>, <span class="ident">x</span>, <span class="ident">y</span>) {
<span class="prelude-val">None</span> <span class="op">=</span><span class="op">></span> <span class="kw">return</span> <span class="prelude-val">None</span>,
<span class="prelude-val">Some</span>(<span class="ident">idx</span>) <span class="op">=</span><span class="op">></span> <span class="self">self</span>.<span class="ident">samples</span>.<span class="ident">as_mut</span>().<span class="ident">get_mut</span>(<span class="ident">idx</span>),
}
}
<span class="doccomment">/// View this buffer as an image over some type of pixel.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This first ensures that all in-bounds coordinates refer to valid indices in the sample</span>
<span class="doccomment">/// buffer. It also checks that the specified pixel format expects the same number of channels</span>
<span class="doccomment">/// that are present in this buffer. Neither are larger nor a smaller number will be accepted.</span>
<span class="doccomment">/// There is no automatic conversion.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">as_view</span><span class="op"><</span><span class="ident">P</span><span class="op">></span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">View</span><span class="op"><</span><span class="kw-2">&</span>[<span class="ident">P</span>::<span class="ident">Subpixel</span>], <span class="ident">P</span><span class="op">></span>, <span class="ident">Error</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">P</span>: <span class="ident">Pixel</span>, <span class="ident">Buffer</span>: <span class="ident">AsRef</span><span class="op"><</span>[<span class="ident">P</span>::<span class="ident">Subpixel</span>]<span class="op">></span>,
{
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">layout</span>.<span class="ident">channels</span> <span class="op">!</span><span class="op">=</span> <span class="ident">P</span>::<span class="ident">channel_count</span>() {
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">WrongColor</span>(<span class="ident">P</span>::<span class="ident">color_type</span>()))
}
<span class="kw">let</span> <span class="ident">as_ref</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">samples</span>.<span class="ident">as_ref</span>();
<span class="kw">if</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">layout</span>.<span class="ident">fits</span>(<span class="ident">as_ref</span>.<span class="ident">len</span>()) {
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">TooLarge</span>)
}
<span class="prelude-val">Ok</span>(<span class="ident">View</span> {
<span class="ident">inner</span>: <span class="ident">FlatSamples</span> {
<span class="ident">samples</span>: <span class="ident">as_ref</span>,
<span class="ident">layout</span>: <span class="self">self</span>.<span class="ident">layout</span>,
<span class="ident">color_hint</span>: <span class="self">self</span>.<span class="ident">color_hint</span>,
},
<span class="ident">phantom</span>: <span class="ident">PhantomData</span>,
})
}
<span class="doccomment">/// View this buffer but keep mutability at a sample level.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This is similar to `as_view` but subtly different from `as_view_mut`. The resulting type</span>
<span class="doccomment">/// can be used as a `GenericImage` with the same prior invariants needed as for `as_view`.</span>
<span class="doccomment">/// It can not be used as a mutable `GenericImage` but does not need channels to be packed in</span>
<span class="doccomment">/// their pixel representation.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This first ensures that all in-bounds coordinates refer to valid indices in the sample</span>
<span class="doccomment">/// buffer. It also checks that the specified pixel format expects the same number of channels</span>
<span class="doccomment">/// that are present in this buffer. Neither are larger nor a smaller number will be accepted.</span>
<span class="doccomment">/// There is no automatic conversion.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// **WARNING**: Note that of course samples may alias, so that the mutable reference returned</span>
<span class="doccomment">/// for one sample can in fact modify other samples as well. Sometimes exactly this is</span>
<span class="doccomment">/// intended.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">as_view_with_mut_samples</span><span class="op"><</span><span class="ident">P</span><span class="op">></span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">View</span><span class="op"><</span><span class="kw-2">&</span><span class="kw-2">mut</span> [<span class="ident">P</span>::<span class="ident">Subpixel</span>], <span class="ident">P</span><span class="op">></span>, <span class="ident">Error</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">P</span>: <span class="ident">Pixel</span>, <span class="ident">Buffer</span>: <span class="ident">AsMut</span><span class="op"><</span>[<span class="ident">P</span>::<span class="ident">Subpixel</span>]<span class="op">></span>,
{
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">layout</span>.<span class="ident">channels</span> <span class="op">!</span><span class="op">=</span> <span class="ident">P</span>::<span class="ident">channel_count</span>() {
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">WrongColor</span>(<span class="ident">P</span>::<span class="ident">color_type</span>()))
}
<span class="kw">let</span> <span class="ident">as_mut</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">samples</span>.<span class="ident">as_mut</span>();
<span class="kw">if</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">layout</span>.<span class="ident">fits</span>(<span class="ident">as_mut</span>.<span class="ident">len</span>()) {
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">TooLarge</span>)
}
<span class="prelude-val">Ok</span>(<span class="ident">View</span> {
<span class="ident">inner</span>: <span class="ident">FlatSamples</span> {
<span class="ident">samples</span>: <span class="ident">as_mut</span>,
<span class="ident">layout</span>: <span class="self">self</span>.<span class="ident">layout</span>,
<span class="ident">color_hint</span>: <span class="self">self</span>.<span class="ident">color_hint</span>,
},
<span class="ident">phantom</span>: <span class="ident">PhantomData</span>,
})
}
<span class="doccomment">/// Interpret this buffer as a mutable image.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// To succeed, the pixels in this buffer may not alias each other and the samples of each</span>
<span class="doccomment">/// pixel must be packed (i.e. `channel_stride` is `1`). The number of channels must be</span>
<span class="doccomment">/// consistent with the channel count expected by the pixel format.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This is similar to an `ImageBuffer` except it is a temporary view that is not normalized as</span>
<span class="doccomment">/// strongly. To get an owning version, consider copying the data into an `ImageBuffer`. This</span>
<span class="doccomment">/// provides many more operations, is possibly faster (if not you may want to open an issue) is</span>
<span class="doccomment">/// generally polished. You can also try to convert this buffer inline, see</span>
<span class="doccomment">/// `ImageBuffer::from_raw`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">as_view_mut</span><span class="op"><</span><span class="ident">P</span><span class="op">></span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">ViewMut</span><span class="op"><</span><span class="kw-2">&</span><span class="kw-2">mut</span> [<span class="ident">P</span>::<span class="ident">Subpixel</span>], <span class="ident">P</span><span class="op">></span>, <span class="ident">Error</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">P</span>: <span class="ident">Pixel</span>, <span class="ident">Buffer</span>: <span class="ident">AsMut</span><span class="op"><</span>[<span class="ident">P</span>::<span class="ident">Subpixel</span>]<span class="op">></span>,
{
<span class="kw">if</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">layout</span>.<span class="ident">is_normal</span>(<span class="ident">NormalForm</span>::<span class="ident">PixelPacked</span>) {
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">NormalFormRequired</span>(<span class="ident">NormalForm</span>::<span class="ident">PixelPacked</span>))
}
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">layout</span>.<span class="ident">channels</span> <span class="op">!</span><span class="op">=</span> <span class="ident">P</span>::<span class="ident">channel_count</span>() {
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">WrongColor</span>(<span class="ident">P</span>::<span class="ident">color_type</span>()))
}
<span class="kw">let</span> <span class="ident">as_mut</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">samples</span>.<span class="ident">as_mut</span>();
<span class="kw">if</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">layout</span>.<span class="ident">fits</span>(<span class="ident">as_mut</span>.<span class="ident">len</span>()) {
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">TooLarge</span>)
}
<span class="prelude-val">Ok</span>(<span class="ident">ViewMut</span> {
<span class="ident">inner</span>: <span class="ident">FlatSamples</span> {
<span class="ident">samples</span>: <span class="ident">as_mut</span>,
<span class="ident">layout</span>: <span class="self">self</span>.<span class="ident">layout</span>,
<span class="ident">color_hint</span>: <span class="self">self</span>.<span class="ident">color_hint</span>,
},
<span class="ident">phantom</span>: <span class="ident">PhantomData</span>,
})
}
<span class="doccomment">/// View the samples as a slice.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The slice is not limited to the region of the image and not all sample indices are valid</span>
<span class="doccomment">/// indices into this buffer. See `image_mut_slice` as an alternative.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">as_slice</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span>[<span class="ident">T</span>] <span class="kw">where</span> <span class="ident">Buffer</span>: <span class="ident">AsRef</span><span class="op"><</span>[<span class="ident">T</span>]<span class="op">></span> {
<span class="self">self</span>.<span class="ident">samples</span>.<span class="ident">as_ref</span>()
}
<span class="doccomment">/// View the samples as a slice.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The slice is not limited to the region of the image and not all sample indices are valid</span>
<span class="doccomment">/// indices into this buffer. See `image_mut_slice` as an alternative.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">as_mut_slice</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="kw-2">mut</span> [<span class="ident">T</span>] <span class="kw">where</span> <span class="ident">Buffer</span>: <span class="ident">AsMut</span><span class="op"><</span>[<span class="ident">T</span>]<span class="op">></span> {
<span class="self">self</span>.<span class="ident">samples</span>.<span class="ident">as_mut</span>()
}
<span class="doccomment">/// Return the portion of the buffer that holds sample values.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This may fail when the coordinates in this image are either out-of-bounds of the underlying</span>
<span class="doccomment">/// buffer or can not be represented. Note that the slice may have holes that do not correspond</span>
<span class="doccomment">/// to any sample in the image represented by it.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">image_slice</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span>[<span class="ident">T</span>]<span class="op">></span> <span class="kw">where</span> <span class="ident">Buffer</span>: <span class="ident">AsRef</span><span class="op"><</span>[<span class="ident">T</span>]<span class="op">></span> {
<span class="kw">let</span> <span class="ident">min_length</span> <span class="op">=</span> <span class="kw">match</span> <span class="self">self</span>.<span class="ident">min_length</span>() {
<span class="prelude-val">None</span> <span class="op">=</span><span class="op">></span> <span class="kw">return</span> <span class="prelude-val">None</span>,
<span class="prelude-val">Some</span>(<span class="ident">index</span>) <span class="op">=</span><span class="op">></span> <span class="ident">index</span>,
};
<span class="kw">let</span> <span class="ident">slice</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">samples</span>.<span class="ident">as_ref</span>();
<span class="kw">if</span> <span class="ident">slice</span>.<span class="ident">len</span>() <span class="op"><</span> <span class="ident">min_length</span> {
<span class="kw">return</span> <span class="prelude-val">None</span>
}
<span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="ident">slice</span>[..<span class="ident">min_length</span>])
}
<span class="doccomment">/// Mutable portion of the buffer that holds sample values.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">image_mut_slice</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="kw-2">mut</span> [<span class="ident">T</span>]<span class="op">></span> <span class="kw">where</span> <span class="ident">Buffer</span>: <span class="ident">AsMut</span><span class="op"><</span>[<span class="ident">T</span>]<span class="op">></span> {
<span class="kw">let</span> <span class="ident">min_length</span> <span class="op">=</span> <span class="kw">match</span> <span class="self">self</span>.<span class="ident">min_length</span>() {
<span class="prelude-val">None</span> <span class="op">=</span><span class="op">></span> <span class="kw">return</span> <span class="prelude-val">None</span>,
<span class="prelude-val">Some</span>(<span class="ident">index</span>) <span class="op">=</span><span class="op">></span> <span class="ident">index</span>,
};
<span class="kw">let</span> <span class="ident">slice</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">samples</span>.<span class="ident">as_mut</span>();
<span class="kw">if</span> <span class="ident">slice</span>.<span class="ident">len</span>() <span class="op"><</span> <span class="ident">min_length</span> {
<span class="kw">return</span> <span class="prelude-val">None</span>
}
<span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">slice</span>[..<span class="ident">min_length</span>])
}
<span class="doccomment">/// Move the data into an image buffer.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This does **not** convert the sample layout. The buffer needs to be in packed row-major form</span>
<span class="doccomment">/// before calling this function. In case of an error, returns the buffer again so that it does</span>
<span class="doccomment">/// not release any allocation.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">try_into_buffer</span><span class="op"><</span><span class="ident">P</span><span class="op">></span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">ImageBuffer</span><span class="op"><</span><span class="ident">P</span>, <span class="ident">Buffer</span><span class="op">></span>, (<span class="ident">Error</span>, <span class="self">Self</span>)<span class="op">></span>
<span class="kw">where</span>
<span class="ident">P</span>: <span class="ident">Pixel</span> <span class="op">+</span> <span class="lifetime">'static</span>,
<span class="ident">P</span>::<span class="ident">Subpixel</span>: <span class="lifetime">'static</span>,
<span class="ident">Buffer</span>: <span class="ident">Deref</span><span class="op"><</span><span class="ident">Target</span><span class="op">=</span>[<span class="ident">P</span>::<span class="ident">Subpixel</span>]<span class="op">></span>,
{
<span class="kw">if</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">is_normal</span>(<span class="ident">NormalForm</span>::<span class="ident">RowMajorPacked</span>) {
<span class="kw">return</span> <span class="prelude-val">Err</span>((<span class="ident">Error</span>::<span class="ident">NormalFormRequired</span>(<span class="ident">NormalForm</span>::<span class="ident">RowMajorPacked</span>), <span class="self">self</span>))
}
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">layout</span>.<span class="ident">channels</span> <span class="op">!</span><span class="op">=</span> <span class="ident">P</span>::<span class="ident">channel_count</span>() {
<span class="kw">return</span> <span class="prelude-val">Err</span>((<span class="ident">Error</span>::<span class="ident">WrongColor</span>(<span class="ident">P</span>::<span class="ident">color_type</span>()), <span class="self">self</span>))
}
<span class="kw">if</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">fits</span>(<span class="self">self</span>.<span class="ident">samples</span>.<span class="ident">deref</span>().<span class="ident">len</span>()) {
<span class="kw">return</span> <span class="prelude-val">Err</span>((<span class="ident">Error</span>::<span class="ident">TooLarge</span>, <span class="self">self</span>))
}
<span class="prelude-val">Ok</span>(<span class="ident">ImageBuffer</span>::<span class="ident">from_raw</span>(<span class="self">self</span>.<span class="ident">layout</span>.<span class="ident">width</span>, <span class="self">self</span>.<span class="ident">layout</span>.<span class="ident">height</span>, <span class="self">self</span>.<span class="ident">samples</span>).<span class="ident">unwrap_or_else</span>(
<span class="op">|</span><span class="op">|</span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Preconditions should have been ensured before conversion"</span>)))
}
<span class="doccomment">/// Get the minimum length of a buffer such that all in-bounds samples have valid indices.</span>
<span class="doccomment">/// </span>
<span class="doccomment">/// This method will allow zero strides, allowing compact representations of monochrome images.</span>
<span class="doccomment">/// To check that no aliasing occurs, try `check_alias_invariants`. For compact images (no</span>
<span class="doccomment">/// aliasing and no unindexed samples) this is `width*height*channels`. But for both of the</span>
<span class="doccomment">/// other cases, the reasoning is slightly more involved.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Explanation</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that there is a difference between `min_length` and the index of the sample</span>
<span class="doccomment">/// 'one-past-the-end`. This is due to strides that may be larger than the dimension below.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ## Example with holes</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Let's look at an example of a grayscale image with </span>
<span class="doccomment">/// * `width_stride = 1`</span>
<span class="doccomment">/// * `width = 2`</span>
<span class="doccomment">/// * `height_stride = 3`</span>
<span class="doccomment">/// * `height = 2`</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```text</span>
<span class="doccomment">/// | x x | x x m | $</span>
<span class="doccomment">/// min_length m ^</span>
<span class="doccomment">/// ^ one-past-the-end $</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The difference is also extreme for empty images with large strides. The one-past-the-end</span>
<span class="doccomment">/// sample index is still as large as the largest of these strides while `min_length = 0`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ## Example with aliasing</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The concept gets even more important when you allow samples to alias each other. Here we</span>
<span class="doccomment">/// have the buffer of a small grayscale image where this is the case, this time we will first</span>
<span class="doccomment">/// show the buffer and then the individual rows below.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// * `width_stride = 1`</span>
<span class="doccomment">/// * `width = 3`</span>
<span class="doccomment">/// * `height_stride = 2`</span>
<span class="doccomment">/// * `height = 2`</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```text</span>
<span class="doccomment">/// 1 2 3 4 5 m</span>
<span class="doccomment">/// |1 2 3| row one</span>
<span class="doccomment">/// |3 4 5| row two</span>
<span class="doccomment">/// ^ m min_length</span>
<span class="doccomment">/// ^ ??? one-past-the-end</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This time 'one-past-the-end' is not even simply the largest stride times the extent of its</span>
<span class="doccomment">/// dimension. That still points inside the image because `height*height_stride = 4` but also</span>
<span class="doccomment">/// `index_of(1, 2) = 4`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">min_length</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">layout</span>.<span class="ident">min_length</span>()
}
<span class="doccomment">/// Check if a buffer of length `len` is large enough.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">fits</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">len</span>: <span class="ident">usize</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> {
<span class="self">self</span>.<span class="ident">layout</span>.<span class="ident">fits</span>(<span class="ident">len</span>)
}
<span class="doccomment">/// If there are any samples aliasing each other.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If this is not the case, it would always be safe to allow mutable access to two different</span>
<span class="doccomment">/// samples at the same time. Otherwise, this operation would need additional checks. When one</span>
<span class="doccomment">/// dimension overflows `usize` with its stride we also consider this aliasing.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">has_aliased_samples</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> {
<span class="self">self</span>.<span class="ident">layout</span>.<span class="ident">has_aliased_samples</span>()
}
<span class="doccomment">/// Check if a buffer fulfills the requirements of a normal form.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Certain conversions have preconditions on the structure of the sample buffer that are not</span>
<span class="doccomment">/// captured (by design) by the type system. These are then checked before the conversion. Such</span>
<span class="doccomment">/// checks can all be done in constant time and will not inspect the buffer content. You can</span>
<span class="doccomment">/// perform these checks yourself when the conversion is not required at this moment but maybe</span>
<span class="doccomment">/// still performed later.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">is_normal</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">form</span>: <span class="ident">NormalForm</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> {
<span class="self">self</span>.<span class="ident">layout</span>.<span class="ident">is_normal</span>(<span class="ident">form</span>)
}
<span class="doccomment">/// Check that the pixel and the channel index are in bounds.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// An in-bound coordinate does not yet guarantee that the corresponding calculation of a</span>
<span class="doccomment">/// buffer index does not overflow. However, if such a buffer large enough to hold all samples</span>
<span class="doccomment">/// actually exists in memory, this porperty of course follows.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">in_bounds</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">channel</span>: <span class="ident">u8</span>, <span class="ident">x</span>: <span class="ident">u32</span>, <span class="ident">y</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> {
<span class="self">self</span>.<span class="ident">layout</span>.<span class="ident">in_bounds</span>(<span class="ident">channel</span>, <span class="ident">x</span>, <span class="ident">y</span>)
}
<span class="doccomment">/// Resolve the index of a particular sample.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// `None` if the index is outside the bounds or does not fit into a `usize`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">index</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">channel</span>: <span class="ident">u8</span>, <span class="ident">x</span>: <span class="ident">u32</span>, <span class="ident">y</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">layout</span>.<span class="ident">index</span>(<span class="ident">channel</span>, <span class="ident">x</span>, <span class="ident">y</span>)
}
<span class="doccomment">/// Get the theoretical position of sample (x, y, channel).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The 'check' is for overflow during index calculation, not that it is contained in the</span>
<span class="doccomment">/// image. Two samples may return the same index, even when one of them is out of bounds. This</span>
<span class="doccomment">/// happens when all strides are `0`, i.e. the image is an arbitrarily large monochrome image.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">index_ignoring_bounds</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">channel</span>: <span class="ident">usize</span>, <span class="ident">x</span>: <span class="ident">usize</span>, <span class="ident">y</span>: <span class="ident">usize</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">layout</span>.<span class="ident">index_ignoring_bounds</span>(<span class="ident">channel</span>, <span class="ident">x</span>, <span class="ident">y</span>)
}
<span class="doccomment">/// Get an index provided it is inbouds.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Assumes that the image is backed by some sufficiently large buffer. Then computation can</span>
<span class="doccomment">/// not overflow as we could represent the maximum coordinate. Since overflow is defined either</span>
<span class="doccomment">/// way, this method can not be unsafe.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">in_bounds_index</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">channel</span>: <span class="ident">u8</span>, <span class="ident">x</span>: <span class="ident">u32</span>, <span class="ident">y</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">></span> <span class="ident">usize</span> {
<span class="self">self</span>.<span class="ident">layout</span>.<span class="ident">in_bounds_index</span>(<span class="ident">channel</span>, <span class="ident">x</span>, <span class="ident">y</span>)
}
<span class="doccomment">/// Shrink the image to the minimum of current and given extents.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This does not modify the strides, so that the resulting sample buffer may have holes</span>
<span class="doccomment">/// created by the shrinking operation. Shrinking could also lead to an non-aliasing image when</span>
<span class="doccomment">/// samples had aliased each other before.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">shrink_to</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">channels</span>: <span class="ident">u8</span>, <span class="ident">width</span>: <span class="ident">u32</span>, <span class="ident">height</span>: <span class="ident">u32</span>) {
<span class="self">self</span>.<span class="ident">layout</span>.<span class="ident">shrink_to</span>(<span class="ident">channels</span>, <span class="ident">width</span>, <span class="ident">height</span>)
}
}
<span class="doccomment">/// A flat buffer that can be used as an image view.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This is a nearly trivial wrapper around a buffer but at least sanitizes by checking the buffer</span>
<span class="doccomment">/// length first and constraining the pixel type.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that this does not eliminate panics as the `AsRef<[T]>` implementation of `Buffer` may be</span>
<span class="doccomment">/// unreliable, i.e. return different buffers at different times. This of course is a non-issue for</span>
<span class="doccomment">/// all common collections where the bounds check once must be enough.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Inner invariants</span>
<span class="doccomment">///</span>
<span class="doccomment">/// * For all indices inside bounds, the corresponding index is valid in the buffer</span>
<span class="doccomment">/// * `P::channel_count()` agrees with `self.inner.layout.channels`</span>
<span class="doccomment">///</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Debug</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">View</span><span class="op"><</span><span class="ident">Buffer</span>, <span class="ident">P</span>: <span class="ident">Pixel</span><span class="op">></span>
<span class="kw">where</span>
<span class="ident">Buffer</span>: <span class="ident">AsRef</span><span class="op"><</span>[<span class="ident">P</span>::<span class="ident">Subpixel</span>]<span class="op">></span>
{
<span class="ident">inner</span>: <span class="ident">FlatSamples</span><span class="op"><</span><span class="ident">Buffer</span><span class="op">></span>,
<span class="ident">phantom</span>: <span class="ident">PhantomData</span><span class="op"><</span><span class="ident">P</span><span class="op">></span>,
}
<span class="doccomment">/// A mutable owning version of a flat buffer.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// While this wraps a buffer similar to `ImageBuffer`, this is mostly intended as a utility. The</span>
<span class="doccomment">/// library endorsed normalized representation is still `ImageBuffer`. Also, the implementation of</span>
<span class="doccomment">/// `AsMut<[P::Subpixel]>` must always yield the same buffer. Therefore there is no public way to</span>
<span class="doccomment">/// construct this with an owning buffer.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Inner invariants</span>
<span class="doccomment">///</span>
<span class="doccomment">/// * For all indices inside bounds, the corresponding index is valid in the buffer</span>
<span class="doccomment">/// * There is no aliasing of samples</span>
<span class="doccomment">/// * The samples are packed, i.e. `self.inner.layout.sample_stride == 1`</span>
<span class="doccomment">/// * `P::channel_count()` agrees with `self.inner.layout.channels`</span>
<span class="doccomment">///</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Debug</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">ViewMut</span><span class="op"><</span><span class="ident">Buffer</span>, <span class="ident">P</span>: <span class="ident">Pixel</span><span class="op">></span>
<span class="kw">where</span>
<span class="ident">Buffer</span>: <span class="ident">AsMut</span><span class="op"><</span>[<span class="ident">P</span>::<span class="ident">Subpixel</span>]<span class="op">></span>
{
<span class="ident">inner</span>: <span class="ident">FlatSamples</span><span class="op"><</span><span class="ident">Buffer</span><span class="op">></span>,
<span class="ident">phantom</span>: <span class="ident">PhantomData</span><span class="op"><</span><span class="ident">P</span><span class="op">></span>,
}
<span class="doccomment">/// Denotes invalid flat sample buffers when trying to convert to stricter types.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The biggest use case being `ImageBuffer` which expects closely packed</span>
<span class="doccomment">/// samples in a row major matrix representation. But this error type may be</span>
<span class="doccomment">/// resused for other import functions. A more versatile user may also try to</span>
<span class="doccomment">/// correct the underlying representation depending on the error variant.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Copy</span>, <span class="ident">Debug</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>, <span class="ident">Hash</span>)]</span>
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">Error</span> {
<span class="doccomment">/// The represented image was too large.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The optional value denotes a possibly accepted maximal bound.</span>
<span class="ident">TooLarge</span>,
<span class="doccomment">/// The represented image can not use this representation.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Has an additional value of the normalized form that would be accepted.</span>
<span class="ident">NormalFormRequired</span>(<span class="ident">NormalForm</span>),
<span class="doccomment">/// The color format did not match the channel count.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// In some cases you might be able to fix this by lowering the reported pixel count of the</span>
<span class="doccomment">/// buffer without touching the strides.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// In very special circumstances you *may* do the opposite. This is **VERY** dangerous but not</span>
<span class="doccomment">/// directly memory unsafe although that will likely alias pixels. One scenario is when you</span>
<span class="doccomment">/// want to construct an `Rgba` image but have only 3 bytes per pixel and for some reason don't</span>
<span class="doccomment">/// care about the value of the alpha channel even though you need `Rgba`.</span>
<span class="ident">WrongColor</span>(<span class="ident">ColorType</span>),
}
<span class="doccomment">/// Different normal forms of buffers.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// A normal form is an unaliased buffer with some additional constraints. The `ÌmageBuffer` uses</span>
<span class="doccomment">/// row major form with packed samples. </span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Copy</span>, <span class="ident">Debug</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>, <span class="ident">Hash</span>)]</span>
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">NormalForm</span> {
<span class="doccomment">/// No pixel aliases another.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Unaliased also guarantees that all index calculations in the image bounds using</span>
<span class="doccomment">/// `dim_index*dim_stride` (such as `x*width_stride + y*height_stride`) do not overflow.</span>
<span class="ident">Unaliased</span>,
<span class="doccomment">/// At least pixels are packed.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Images of these types can wrap `[T]`-slices into the standard color types. This is a</span>
<span class="doccomment">/// precondition for `GenericImage` which requires by-reference access to pixels.</span>
<span class="ident">PixelPacked</span>,
<span class="doccomment">/// All samples are packed.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This is orthogonal to `PixelPacked`. It requires that there are no holes in the image but</span>
<span class="doccomment">/// it is not necessary that the pixel samples themselves are adjacent. An example of this</span>
<span class="doccomment">/// behaviour is a planar image layout.</span>
<span class="ident">ImagePacked</span>,
<span class="doccomment">/// The samples are in row-major form and all samples are packed.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// In addition to `PixelPacked` and `ImagePacked` this also asserts that the pixel matrix is</span>
<span class="doccomment">/// in row-major form. </span>
<span class="ident">RowMajorPacked</span>,
<span class="doccomment">/// The samples are in column-major form and all samples are packed.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// In addition to `PixelPacked` and `ImagePacked` this also asserts that the pixel matrix is</span>
<span class="doccomment">/// in column-major form. </span>
<span class="ident">ColumnMajorPacked</span>,
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">Buffer</span>, <span class="ident">P</span>: <span class="ident">Pixel</span><span class="op">></span> <span class="ident">View</span><span class="op"><</span><span class="ident">Buffer</span>, <span class="ident">P</span><span class="op">></span>
<span class="kw">where</span>
<span class="ident">Buffer</span>: <span class="ident">AsRef</span><span class="op"><</span>[<span class="ident">P</span>::<span class="ident">Subpixel</span>]<span class="op">></span>
{
<span class="doccomment">/// Take out the sample buffer.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Gives up the normalization invariants on the buffer format.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">into_inner</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">FlatSamples</span><span class="op"><</span><span class="ident">Buffer</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">inner</span>
}
<span class="doccomment">/// Get a reference on the inner sample descriptor.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// There is no mutable counterpart as modifying the buffer format, including strides and</span>
<span class="doccomment">/// lengths, could invalidate the accessibility invariants of the `View`. It is not specified</span>
<span class="doccomment">/// if the inner buffer is the same as the buffer of the image from which this view was</span>
<span class="doccomment">/// created. It might have been truncated as an optimization.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">flat</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="ident">FlatSamples</span><span class="op"><</span><span class="ident">Buffer</span><span class="op">></span> {
<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">inner</span>
}
<span class="doccomment">/// Get a reference on the inner buffer.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// There is no mutable counter part since it is not intended to allow you to reassign the</span>
<span class="doccomment">/// buffer or otherwise change its size or properties.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">samples</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="ident">Buffer</span> {
<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">samples</span>
}
<span class="doccomment">/// Get a reference to a selected subpixel if it is in-bounds.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This method will return `None` when the sample is out-of-bounds. All errors that could</span>
<span class="doccomment">/// occur due to overflow have been eliminated while construction the `View`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_sample</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">channel</span>: <span class="ident">u8</span>, <span class="ident">x</span>: <span class="ident">u32</span>, <span class="ident">y</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">P</span>::<span class="ident">Subpixel</span><span class="op">></span> {
<span class="kw">if</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">in_bounds</span>(<span class="ident">channel</span>, <span class="ident">x</span>, <span class="ident">y</span>) {
<span class="kw">return</span> <span class="prelude-val">None</span>
}
<span class="kw">let</span> <span class="ident">index</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">in_bounds_index</span>(<span class="ident">channel</span>, <span class="ident">x</span>, <span class="ident">y</span>);
<span class="comment">// Should always be `Some(_)` but checking is more costly.</span>
<span class="self">self</span>.<span class="ident">samples</span>().<span class="ident">as_ref</span>().<span class="ident">get</span>(<span class="ident">index</span>)
}
<span class="doccomment">/// Get a mutable reference to a selected subpixel if it is in-bounds.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This is relevant only when constructed with `FlatSamples::as_view_with_mut_samples`. This</span>
<span class="doccomment">/// method will return `None` when the sample is out-of-bounds. All errors that could occur due</span>
<span class="doccomment">/// to overflow have been eliminated while construction the `View`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// **WARNING**: Note that of course samples may alias, so that the mutable reference returned</span>
<span class="doccomment">/// here can in fact modify more than the coordinate in the argument.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_mut_sample</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">channel</span>: <span class="ident">u8</span>, <span class="ident">x</span>: <span class="ident">u32</span>, <span class="ident">y</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">P</span>::<span class="ident">Subpixel</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">Buffer</span>: <span class="ident">AsMut</span><span class="op"><</span>[<span class="ident">P</span>::<span class="ident">Subpixel</span>]<span class="op">></span>
{
<span class="kw">if</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">in_bounds</span>(<span class="ident">channel</span>, <span class="ident">x</span>, <span class="ident">y</span>) {
<span class="kw">return</span> <span class="prelude-val">None</span>
}
<span class="kw">let</span> <span class="ident">index</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">in_bounds_index</span>(<span class="ident">channel</span>, <span class="ident">x</span>, <span class="ident">y</span>);
<span class="comment">// Should always be `Some(_)` but checking is more costly.</span>
<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">samples</span>.<span class="ident">as_mut</span>().<span class="ident">get_mut</span>(<span class="ident">index</span>)
}
<span class="doccomment">/// Get the minimum length of a buffer such that all in-bounds samples have valid indices.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// See `FlatSamples::min_length`. This method will always succeed.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">min_length</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">usize</span> {
<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">min_length</span>().<span class="ident">unwrap</span>()
}
<span class="doccomment">/// Return the portion of the buffer that holds sample values.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// While this can not fail–the validity of all coordinates has been validated during the</span>
<span class="doccomment">/// conversion from `FlatSamples`–the resulting slice may still contain holes.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">image_slice</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span>[<span class="ident">P</span>::<span class="ident">Subpixel</span>] {
<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">samples</span>().<span class="ident">as_ref</span>()[..<span class="self">self</span>.<span class="ident">min_length</span>()]
}
<span class="doccomment">/// Return the mutable portion of the buffer that holds sample values.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This is relevant only when constructed with `FlatSamples::as_view_with_mut_samples`. While</span>
<span class="doccomment">/// this can not fail–the validity of all coordinates has been validated during the conversion</span>
<span class="doccomment">/// from `FlatSamples`–the resulting slice may still contain holes.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">image_mut_slice</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="kw-2">mut</span> [<span class="ident">P</span>::<span class="ident">Subpixel</span>]
<span class="kw">where</span> <span class="ident">Buffer</span>: <span class="ident">AsMut</span><span class="op"><</span>[<span class="ident">P</span>::<span class="ident">Subpixel</span>]<span class="op">></span>
{
<span class="kw">let</span> <span class="ident">min_length</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">min_length</span>();
<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">samples</span>.<span class="ident">as_mut</span>()[..<span class="ident">min_length</span>]
}
<span class="doccomment">/// Shrink the inner image.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The new dimensions will be the minimum of the previous dimensions. Since the set of</span>
<span class="doccomment">/// in-bounds pixels afterwards is a subset of the current ones, this is allowed on a `View`.</span>
<span class="doccomment">/// Note that you can not change the number of channels as an intrinsic property of `P`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">shrink_to</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">width</span>: <span class="ident">u32</span>, <span class="ident">height</span>: <span class="ident">u32</span>) {
<span class="kw">let</span> <span class="ident">channels</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">layout</span>.<span class="ident">channels</span>;
<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">shrink_to</span>(<span class="ident">channels</span>, <span class="ident">width</span>, <span class="ident">height</span>)
}
<span class="doccomment">/// Try to convert this into an image with mutable pixels.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The resulting image implements `GenericImage` in addition to `GenericImageView`. While this</span>
<span class="doccomment">/// has mutable samples, it does not enforce that pixel can not alias and that samples are</span>
<span class="doccomment">/// packed enough for a mutable pixel reference. This is slightly cheaper than the chain</span>
<span class="doccomment">/// `self.into_inner().as_view_mut()` and keeps the `View` alive on failure.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// # use image::{Rgb, RgbImage};</span>
<span class="doccomment">/// let mut buffer = RgbImage::new(480, 640).into_flat_samples();</span>
<span class="doccomment">/// let view = buffer.as_view_with_mut_samples::<Rgb<u8>>().unwrap();</span>
<span class="doccomment">///</span>
<span class="doccomment">/// // Inspect some pixels, …</span>
<span class="doccomment">///</span>
<span class="doccomment">/// // Doesn't fail because it was originally an `RgbImage`.</span>
<span class="doccomment">/// let view_mut = view.try_upgrade().unwrap();</span>
<span class="doccomment">/// ```</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">try_upgrade</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">ViewMut</span><span class="op"><</span><span class="ident">Buffer</span>, <span class="ident">P</span><span class="op">></span>, (<span class="ident">Error</span>, <span class="self">Self</span>)<span class="op">></span>
<span class="kw">where</span> <span class="ident">Buffer</span>: <span class="ident">AsMut</span><span class="op"><</span>[<span class="ident">P</span>::<span class="ident">Subpixel</span>]<span class="op">></span>
{
<span class="kw">if</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">is_normal</span>(<span class="ident">NormalForm</span>::<span class="ident">PixelPacked</span>) {
<span class="kw">return</span> <span class="prelude-val">Err</span>((<span class="ident">Error</span>::<span class="ident">NormalFormRequired</span>(<span class="ident">NormalForm</span>::<span class="ident">PixelPacked</span>), <span class="self">self</span>))
}
<span class="comment">// No length check or channel count check required, all the same.</span>
<span class="prelude-val">Ok</span>(<span class="ident">ViewMut</span> {
<span class="ident">inner</span>: <span class="self">self</span>.<span class="ident">inner</span>,
<span class="ident">phantom</span>: <span class="ident">PhantomData</span>,
})
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">Buffer</span>, <span class="ident">P</span>: <span class="ident">Pixel</span><span class="op">></span> <span class="ident">ViewMut</span><span class="op"><</span><span class="ident">Buffer</span>, <span class="ident">P</span><span class="op">></span>
<span class="kw">where</span>
<span class="ident">Buffer</span>: <span class="ident">AsMut</span><span class="op"><</span>[<span class="ident">P</span>::<span class="ident">Subpixel</span>]<span class="op">></span>
{
<span class="doccomment">/// Take out the sample buffer.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Gives up the normalization invariants on the buffer format.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">into_inner</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">FlatSamples</span><span class="op"><</span><span class="ident">Buffer</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">inner</span>
}
<span class="doccomment">/// Get a reference on the sample buffer descriptor.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// There is no mutable counterpart as modifying the buffer format, including strides and</span>
<span class="doccomment">/// lengths, could invalidate the accessibility invariants of the `View`. It is not specified</span>
<span class="doccomment">/// if the inner buffer is the same as the buffer of the image from which this view was</span>
<span class="doccomment">/// created. It might have been truncated as an optimization.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">flat</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="ident">FlatSamples</span><span class="op"><</span><span class="ident">Buffer</span><span class="op">></span> {
<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">inner</span>
}
<span class="doccomment">/// Get a reference on the inner buffer.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// There is no mutable counter part since it is not intended to allow you to reassign the</span>
<span class="doccomment">/// buffer or otherwise change its size or properties. However, its contents can be accessed</span>
<span class="doccomment">/// mutable through a slice with `image_mut_slice`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">samples</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="ident">Buffer</span> {
<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">samples</span>
}
<span class="doccomment">/// Get the minimum length of a buffer such that all in-bounds samples have valid indices.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// See `FlatSamples::min_length`. This method will always succeed.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">min_length</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">usize</span> {
<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">min_length</span>().<span class="ident">unwrap</span>()
}
<span class="doccomment">/// Get a reference to a selected subpixel.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This method will return `None` when the sample is out-of-bounds. All errors that could</span>
<span class="doccomment">/// occur due to overflow have been eliminated while construction the `View`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_sample</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">channel</span>: <span class="ident">u8</span>, <span class="ident">x</span>: <span class="ident">u32</span>, <span class="ident">y</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">P</span>::<span class="ident">Subpixel</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">Buffer</span>: <span class="ident">AsRef</span><span class="op"><</span>[<span class="ident">P</span>::<span class="ident">Subpixel</span>]<span class="op">></span>
{
<span class="kw">if</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">in_bounds</span>(<span class="ident">channel</span>, <span class="ident">x</span>, <span class="ident">y</span>) {
<span class="kw">return</span> <span class="prelude-val">None</span>
}
<span class="kw">let</span> <span class="ident">index</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">in_bounds_index</span>(<span class="ident">channel</span>, <span class="ident">x</span>, <span class="ident">y</span>);
<span class="comment">// Should always be `Some(_)` but checking is more costly.</span>
<span class="self">self</span>.<span class="ident">samples</span>().<span class="ident">as_ref</span>().<span class="ident">get</span>(<span class="ident">index</span>)
}
<span class="doccomment">/// Get a mutable reference to a selected sample.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This method will return `None` when the sample is out-of-bounds. All errors that could</span>
<span class="doccomment">/// occur due to overflow have been eliminated while construction the `View`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_mut_sample</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">channel</span>: <span class="ident">u8</span>, <span class="ident">x</span>: <span class="ident">u32</span>, <span class="ident">y</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">P</span>::<span class="ident">Subpixel</span><span class="op">></span> {
<span class="kw">if</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">in_bounds</span>(<span class="ident">channel</span>, <span class="ident">x</span>, <span class="ident">y</span>) {
<span class="kw">return</span> <span class="prelude-val">None</span>
}
<span class="kw">let</span> <span class="ident">index</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">in_bounds_index</span>(<span class="ident">channel</span>, <span class="ident">x</span>, <span class="ident">y</span>);
<span class="comment">// Should always be `Some(_)` but checking is more costly.</span>
<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">samples</span>.<span class="ident">as_mut</span>().<span class="ident">get_mut</span>(<span class="ident">index</span>)
}
<span class="doccomment">/// Return the portion of the buffer that holds sample values.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// While this can not fail–the validity of all coordinates has been validated during the</span>
<span class="doccomment">/// conversion from `FlatSamples`–the resulting slice may still contain holes.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">image_slice</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span>[<span class="ident">P</span>::<span class="ident">Subpixel</span>] <span class="kw">where</span> <span class="ident">Buffer</span>: <span class="ident">AsRef</span><span class="op"><</span>[<span class="ident">P</span>::<span class="ident">Subpixel</span>]<span class="op">></span> {
<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">samples</span>.<span class="ident">as_ref</span>()[..<span class="self">self</span>.<span class="ident">min_length</span>()]
}
<span class="doccomment">/// Return the mutable buffer that holds sample values.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">image_mut_slice</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="kw-2">mut</span> [<span class="ident">P</span>::<span class="ident">Subpixel</span>] {
<span class="kw">let</span> <span class="ident">length</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">min_length</span>();
<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">samples</span>.<span class="ident">as_mut</span>()[..<span class="ident">length</span>]
}
<span class="doccomment">/// Shrink the inner image.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The new dimensions will be the minimum of the previous dimensions. Since the set of</span>
<span class="doccomment">/// in-bounds pixels afterwards is a subset of the current ones, this is allowed on a `View`.</span>
<span class="doccomment">/// Note that you can not change the number of channels as an intrinsic property of `P`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">shrink_to</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">width</span>: <span class="ident">u32</span>, <span class="ident">height</span>: <span class="ident">u32</span>) {
<span class="kw">let</span> <span class="ident">channels</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">layout</span>.<span class="ident">channels</span>;
<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">shrink_to</span>(<span class="ident">channels</span>, <span class="ident">width</span>, <span class="ident">height</span>)
}
}
<span class="comment">// The out-of-bounds panic for single sample access similar to `slice::index`.</span>
<span class="attribute">#[<span class="ident">inline</span>(<span class="ident">never</span>)]</span>
<span class="attribute">#[<span class="ident">cold</span>]</span>
<span class="kw">fn</span> <span class="ident">panic_cwh_out_of_bounds</span>(
(<span class="ident">c</span>, <span class="ident">x</span>, <span class="ident">y</span>): (<span class="ident">u8</span>, <span class="ident">u32</span>, <span class="ident">u32</span>),
<span class="ident">bounds</span>: (<span class="ident">u8</span>, <span class="ident">u32</span>, <span class="ident">u32</span>),
<span class="ident">strides</span>: (<span class="ident">usize</span>, <span class="ident">usize</span>, <span class="ident">usize</span>)) <span class="op">-</span><span class="op">></span> <span class="op">!</span>
{
<span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Sample coordinates {:?} out of sample matrix bounds {:?} with strides {:?}"</span>, (<span class="ident">c</span>, <span class="ident">x</span>, <span class="ident">y</span>), <span class="ident">bounds</span>, <span class="ident">strides</span>)
}
<span class="comment">// The out-of-bounds panic for pixel access similar to `slice::index`.</span>
<span class="attribute">#[<span class="ident">inline</span>(<span class="ident">never</span>)]</span>
<span class="attribute">#[<span class="ident">cold</span>]</span>
<span class="kw">fn</span> <span class="ident">panic_pixel_out_of_bounds</span>(
(<span class="ident">x</span>, <span class="ident">y</span>): (<span class="ident">u32</span>, <span class="ident">u32</span>),
<span class="ident">bounds</span>: (<span class="ident">u32</span>, <span class="ident">u32</span>)) <span class="op">-</span><span class="op">></span> <span class="op">!</span>
{
<span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Image index {:?} out of bounds {:?}"</span>, (<span class="ident">x</span>, <span class="ident">y</span>), <span class="ident">bounds</span>)
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">Buffer</span><span class="op">></span> <span class="ident">Index</span><span class="op"><</span>(<span class="ident">u8</span>, <span class="ident">u32</span>, <span class="ident">u32</span>)<span class="op">></span> <span class="kw">for</span> <span class="ident">FlatSamples</span><span class="op"><</span><span class="ident">Buffer</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">Buffer</span>: <span class="ident">Index</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span>
{
<span class="kw">type</span> <span class="ident">Output</span> <span class="op">=</span> <span class="ident">Buffer</span>::<span class="ident">Output</span>;
<span class="doccomment">/// Return a reference to a single sample at specified coordinates.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Panics</span>
<span class="doccomment">///</span>
<span class="doccomment">/// When the coordinates are out of bounds or the index calculation fails.</span>
<span class="kw">fn</span> <span class="ident">index</span>(<span class="kw-2">&</span><span class="self">self</span>, (<span class="ident">c</span>, <span class="ident">x</span>, <span class="ident">y</span>): (<span class="ident">u8</span>, <span class="ident">u32</span>, <span class="ident">u32</span>)) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="self">Self</span>::<span class="ident">Output</span> {
<span class="kw">let</span> <span class="ident">bounds</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">bounds</span>();
<span class="kw">let</span> <span class="ident">strides</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">strides_cwh</span>();
<span class="kw">let</span> <span class="ident">index</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">index</span>(<span class="ident">c</span>, <span class="ident">x</span>, <span class="ident">y</span>).<span class="ident">unwrap_or_else</span>(<span class="op">|</span><span class="op">|</span>
<span class="ident">panic_cwh_out_of_bounds</span>((<span class="ident">c</span>, <span class="ident">x</span>, <span class="ident">y</span>), <span class="ident">bounds</span>, <span class="ident">strides</span>));
<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">samples</span>[<span class="ident">index</span>]
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">Buffer</span><span class="op">></span> <span class="ident">IndexMut</span><span class="op"><</span>(<span class="ident">u8</span>, <span class="ident">u32</span>, <span class="ident">u32</span>)<span class="op">></span> <span class="kw">for</span> <span class="ident">FlatSamples</span><span class="op"><</span><span class="ident">Buffer</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">Buffer</span>: <span class="ident">IndexMut</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span>
{
<span class="doccomment">/// Return a mutable reference to a single sample at specified coordinates.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Panics</span>
<span class="doccomment">///</span>
<span class="doccomment">/// When the coordinates are out of bounds or the index calculation fails.</span>
<span class="kw">fn</span> <span class="ident">index_mut</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, (<span class="ident">c</span>, <span class="ident">x</span>, <span class="ident">y</span>): (<span class="ident">u8</span>, <span class="ident">u32</span>, <span class="ident">u32</span>)) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">Self</span>::<span class="ident">Output</span> {
<span class="kw">let</span> <span class="ident">bounds</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">bounds</span>();
<span class="kw">let</span> <span class="ident">strides</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">strides_cwh</span>();
<span class="kw">let</span> <span class="ident">index</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">index</span>(<span class="ident">c</span>, <span class="ident">x</span>, <span class="ident">y</span>).<span class="ident">unwrap_or_else</span>(<span class="op">|</span><span class="op">|</span>
<span class="ident">panic_cwh_out_of_bounds</span>((<span class="ident">c</span>, <span class="ident">x</span>, <span class="ident">y</span>), <span class="ident">bounds</span>, <span class="ident">strides</span>));
<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">samples</span>[<span class="ident">index</span>]
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">Buffer</span>, <span class="ident">P</span>: <span class="ident">Pixel</span><span class="op">></span> <span class="ident">GenericImageView</span> <span class="kw">for</span> <span class="ident">View</span><span class="op"><</span><span class="ident">Buffer</span>, <span class="ident">P</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">Buffer</span>: <span class="ident">AsRef</span><span class="op"><</span>[<span class="ident">P</span>::<span class="ident">Subpixel</span>]<span class="op">></span>
{
<span class="kw">type</span> <span class="ident">Pixel</span> <span class="op">=</span> <span class="ident">P</span>;
<span class="comment">// We don't proxy an inner image.</span>
<span class="kw">type</span> <span class="ident">InnerImageView</span> <span class="op">=</span> <span class="self">Self</span>;
<span class="kw">fn</span> <span class="ident">dimensions</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> (<span class="ident">u32</span>, <span class="ident">u32</span>) {
(<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">layout</span>.<span class="ident">width</span>, <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">layout</span>.<span class="ident">height</span>)
}
<span class="kw">fn</span> <span class="ident">bounds</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> (<span class="ident">u32</span>, <span class="ident">u32</span>, <span class="ident">u32</span>, <span class="ident">u32</span>) {
<span class="kw">let</span> (<span class="ident">w</span>, <span class="ident">h</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">dimensions</span>();
(<span class="number">0</span>, <span class="ident">w</span>, <span class="number">0</span>, <span class="ident">h</span>)
}
<span class="kw">fn</span> <span class="ident">in_bounds</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">x</span>: <span class="ident">u32</span>, <span class="ident">y</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> {
<span class="kw">let</span> (<span class="ident">w</span>, <span class="ident">h</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">dimensions</span>();
<span class="ident">x</span> <span class="op"><</span> <span class="ident">w</span> <span class="kw-2">&</span><span class="op">&</span> <span class="ident">y</span> <span class="op"><</span> <span class="ident">h</span>
}
<span class="kw">fn</span> <span class="ident">get_pixel</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">x</span>: <span class="ident">u32</span>, <span class="ident">y</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span>::<span class="ident">Pixel</span> {
<span class="kw">if</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">in_bounds</span>(<span class="number">0</span>, <span class="ident">x</span>, <span class="ident">y</span>) {
<span class="ident">panic_pixel_out_of_bounds</span>((<span class="ident">x</span>, <span class="ident">y</span>), <span class="self">self</span>.<span class="ident">dimensions</span>())
}
<span class="kw">let</span> <span class="ident">image</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">samples</span>.<span class="ident">as_ref</span>();
<span class="kw">let</span> <span class="ident">base_index</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">in_bounds_index</span>(<span class="number">0</span>, <span class="ident">x</span>, <span class="ident">y</span>);
<span class="kw">let</span> <span class="ident">channels</span> <span class="op">=</span> <span class="ident">P</span>::<span class="ident">channel_count</span>() <span class="kw">as</span> <span class="ident">usize</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buffer</span> <span class="op">=</span> [<span class="ident">Zero</span>::<span class="ident">zero</span>(); <span class="number">256</span>];
<span class="ident">buffer</span>.<span class="ident">iter_mut</span>().<span class="ident">enumerate</span>().<span class="ident">take</span>(<span class="ident">channels</span>).<span class="ident">for_each</span>(<span class="op">|</span>(<span class="ident">c</span>, <span class="ident">to</span>)<span class="op">|</span> {
<span class="kw">let</span> <span class="ident">index</span> <span class="op">=</span> <span class="ident">base_index</span> <span class="op">+</span> <span class="ident">c</span><span class="kw-2">*</span><span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">layout</span>.<span class="ident">channel_stride</span>;
<span class="kw-2">*</span><span class="ident">to</span> <span class="op">=</span> <span class="ident">image</span>[<span class="ident">index</span>];
});
<span class="ident">P</span>::<span class="ident">from_slice</span>(<span class="kw-2">&</span><span class="ident">buffer</span>[..<span class="ident">channels</span>]).<span class="ident">clone</span>()
}
<span class="kw">fn</span> <span class="ident">inner</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="self">Self</span> {
<span class="self">self</span> <span class="comment">// There is no other inner image.</span>
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">Buffer</span>, <span class="ident">P</span>: <span class="ident">Pixel</span><span class="op">></span> <span class="ident">GenericImageView</span> <span class="kw">for</span> <span class="ident">ViewMut</span><span class="op"><</span><span class="ident">Buffer</span>, <span class="ident">P</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">Buffer</span>: <span class="ident">AsMut</span><span class="op"><</span>[<span class="ident">P</span>::<span class="ident">Subpixel</span>]<span class="op">></span> <span class="op">+</span> <span class="ident">AsRef</span><span class="op"><</span>[<span class="ident">P</span>::<span class="ident">Subpixel</span>]<span class="op">></span>,
{
<span class="kw">type</span> <span class="ident">Pixel</span> <span class="op">=</span> <span class="ident">P</span>;
<span class="comment">// We don't proxy an inner image.</span>
<span class="kw">type</span> <span class="ident">InnerImageView</span> <span class="op">=</span> <span class="self">Self</span>;
<span class="kw">fn</span> <span class="ident">dimensions</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> (<span class="ident">u32</span>, <span class="ident">u32</span>) {
(<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">layout</span>.<span class="ident">width</span>, <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">layout</span>.<span class="ident">height</span>)
}
<span class="kw">fn</span> <span class="ident">bounds</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> (<span class="ident">u32</span>, <span class="ident">u32</span>, <span class="ident">u32</span>, <span class="ident">u32</span>) {
<span class="kw">let</span> (<span class="ident">w</span>, <span class="ident">h</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">dimensions</span>();
(<span class="number">0</span>, <span class="ident">w</span>, <span class="number">0</span>, <span class="ident">h</span>)
}
<span class="kw">fn</span> <span class="ident">in_bounds</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">x</span>: <span class="ident">u32</span>, <span class="ident">y</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> {
<span class="kw">let</span> (<span class="ident">w</span>, <span class="ident">h</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">dimensions</span>();
<span class="ident">x</span> <span class="op"><</span> <span class="ident">w</span> <span class="kw-2">&</span><span class="op">&</span> <span class="ident">y</span> <span class="op"><</span> <span class="ident">h</span>
}
<span class="kw">fn</span> <span class="ident">get_pixel</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">x</span>: <span class="ident">u32</span>, <span class="ident">y</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span>::<span class="ident">Pixel</span> {
<span class="kw">if</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">in_bounds</span>(<span class="number">0</span>, <span class="ident">x</span>, <span class="ident">y</span>) {
<span class="ident">panic_pixel_out_of_bounds</span>((<span class="ident">x</span>, <span class="ident">y</span>), <span class="self">self</span>.<span class="ident">dimensions</span>())
}
<span class="kw">let</span> <span class="ident">image</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">samples</span>.<span class="ident">as_ref</span>();
<span class="kw">let</span> <span class="ident">base_index</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">in_bounds_index</span>(<span class="number">0</span>, <span class="ident">x</span>, <span class="ident">y</span>);
<span class="kw">let</span> <span class="ident">channels</span> <span class="op">=</span> <span class="ident">P</span>::<span class="ident">channel_count</span>() <span class="kw">as</span> <span class="ident">usize</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buffer</span> <span class="op">=</span> [<span class="ident">Zero</span>::<span class="ident">zero</span>(); <span class="number">256</span>];
<span class="ident">buffer</span>.<span class="ident">iter_mut</span>().<span class="ident">enumerate</span>().<span class="ident">take</span>(<span class="ident">channels</span>).<span class="ident">for_each</span>(<span class="op">|</span>(<span class="ident">c</span>, <span class="ident">to</span>)<span class="op">|</span> {
<span class="kw">let</span> <span class="ident">index</span> <span class="op">=</span> <span class="ident">base_index</span> <span class="op">+</span> <span class="ident">c</span><span class="kw-2">*</span><span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">layout</span>.<span class="ident">channel_stride</span>;
<span class="kw-2">*</span><span class="ident">to</span> <span class="op">=</span> <span class="ident">image</span>[<span class="ident">index</span>];
});
<span class="ident">P</span>::<span class="ident">from_slice</span>(<span class="kw-2">&</span><span class="ident">buffer</span>[..<span class="ident">channels</span>]).<span class="ident">clone</span>()
}
<span class="kw">fn</span> <span class="ident">inner</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="self">Self</span> {
<span class="self">self</span> <span class="comment">// There is no other inner image.</span>
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">Buffer</span>, <span class="ident">P</span>: <span class="ident">Pixel</span><span class="op">></span> <span class="ident">GenericImage</span> <span class="kw">for</span> <span class="ident">ViewMut</span><span class="op"><</span><span class="ident">Buffer</span>, <span class="ident">P</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">Buffer</span>: <span class="ident">AsMut</span><span class="op"><</span>[<span class="ident">P</span>::<span class="ident">Subpixel</span>]<span class="op">></span> <span class="op">+</span> <span class="ident">AsRef</span><span class="op"><</span>[<span class="ident">P</span>::<span class="ident">Subpixel</span>]<span class="op">></span>,
{
<span class="kw">type</span> <span class="ident">InnerImage</span> <span class="op">=</span> <span class="self">Self</span>;
<span class="kw">fn</span> <span class="ident">get_pixel_mut</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">x</span>: <span class="ident">u32</span>, <span class="ident">y</span>: <span class="ident">u32</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">Self</span>::<span class="ident">Pixel</span> {
<span class="kw">if</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">in_bounds</span>(<span class="number">0</span>, <span class="ident">x</span>, <span class="ident">y</span>) {
<span class="ident">panic_pixel_out_of_bounds</span>((<span class="ident">x</span>, <span class="ident">y</span>), <span class="self">self</span>.<span class="ident">dimensions</span>())
}
<span class="kw">let</span> <span class="ident">base_index</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">in_bounds_index</span>(<span class="number">0</span>, <span class="ident">x</span>, <span class="ident">y</span>);
<span class="kw">let</span> <span class="ident">channel_count</span> <span class="op">=</span> <span class="op"><</span><span class="ident">P</span> <span class="kw">as</span> <span class="ident">Pixel</span><span class="op">></span>::<span class="ident">channel_count</span>() <span class="kw">as</span> <span class="ident">usize</span>;
<span class="kw">let</span> <span class="ident">pixel_range</span> <span class="op">=</span> <span class="ident">base_index</span>..<span class="ident">base_index</span> <span class="op">+</span> <span class="ident">channel_count</span>;
<span class="ident">P</span>::<span class="ident">from_slice_mut</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">samples</span>.<span class="ident">as_mut</span>()[<span class="ident">pixel_range</span>])
}
<span class="kw">fn</span> <span class="ident">put_pixel</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">x</span>: <span class="ident">u32</span>, <span class="ident">y</span>: <span class="ident">u32</span>, <span class="ident">pixel</span>: <span class="self">Self</span>::<span class="ident">Pixel</span>) {
<span class="kw-2">*</span><span class="self">self</span>.<span class="ident">get_pixel_mut</span>(<span class="ident">x</span>, <span class="ident">y</span>) <span class="op">=</span> <span class="ident">pixel</span>;
}
<span class="kw">fn</span> <span class="ident">blend_pixel</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">x</span>: <span class="ident">u32</span>, <span class="ident">y</span>: <span class="ident">u32</span>, <span class="ident">pixel</span>: <span class="self">Self</span>::<span class="ident">Pixel</span>) {
<span class="self">self</span>.<span class="ident">get_pixel_mut</span>(<span class="ident">x</span>, <span class="ident">y</span>).<span class="ident">blend</span>(<span class="kw-2">&</span><span class="ident">pixel</span>);
}
<span class="kw">fn</span> <span class="ident">inner_mut</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">Self</span> {
<span class="self">self</span>
}
}
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">Error</span><span class="op">></span> <span class="kw">for</span> <span class="ident">ImageError</span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">error</span>: <span class="ident">Error</span>) <span class="op">-</span><span class="op">></span> <span class="ident">ImageError</span> {
<span class="kw">match</span> <span class="ident">error</span> {
<span class="ident">Error</span>::<span class="ident">TooLarge</span> <span class="op">=</span><span class="op">></span> <span class="ident">ImageError</span>::<span class="ident">DimensionError</span>,
<span class="ident">Error</span>::<span class="ident">WrongColor</span>(<span class="ident">color</span>) <span class="op">=</span><span class="op">></span> <span class="ident">ImageError</span>::<span class="ident">UnsupportedColor</span>(<span class="ident">color</span>),
<span class="ident">Error</span>::<span class="ident">NormalFormRequired</span>(<span class="ident">form</span>) <span class="op">=</span><span class="op">></span> <span class="ident">ImageError</span>::<span class="ident">FormatError</span>(
<span class="macro">format</span><span class="macro">!</span>(<span class="string">"Required sample buffer in normal form {:?}"</span>, <span class="ident">form</span>)),
}
}
}
<span class="kw">impl</span> <span class="ident">PartialOrd</span> <span class="kw">for</span> <span class="ident">NormalForm</span> {
<span class="doccomment">/// Compares the logical preconditions.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// `a < b` if the normal form `a` has less preconditions than `b`.</span>
<span class="kw">fn</span> <span class="ident">partial_cmp</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="self">Self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">cmp</span>::<span class="ident">Ordering</span><span class="op">></span> {
<span class="kw">match</span> (<span class="kw-2">*</span><span class="self">self</span>, <span class="kw-2">*</span><span class="ident">other</span>) {
(<span class="ident">NormalForm</span>::<span class="ident">Unaliased</span>, <span class="ident">NormalForm</span>::<span class="ident">Unaliased</span>) <span class="op">=</span><span class="op">></span> <span class="prelude-val">Some</span>(<span class="ident">cmp</span>::<span class="ident">Ordering</span>::<span class="ident">Equal</span>),
(<span class="ident">NormalForm</span>::<span class="ident">PixelPacked</span>, <span class="ident">NormalForm</span>::<span class="ident">PixelPacked</span>) <span class="op">=</span><span class="op">></span> <span class="prelude-val">Some</span>(<span class="ident">cmp</span>::<span class="ident">Ordering</span>::<span class="ident">Equal</span>),
(<span class="ident">NormalForm</span>::<span class="ident">ImagePacked</span>, <span class="ident">NormalForm</span>::<span class="ident">ImagePacked</span>) <span class="op">=</span><span class="op">></span> <span class="prelude-val">Some</span>(<span class="ident">cmp</span>::<span class="ident">Ordering</span>::<span class="ident">Equal</span>),
(<span class="ident">NormalForm</span>::<span class="ident">RowMajorPacked</span>, <span class="ident">NormalForm</span>::<span class="ident">RowMajorPacked</span>) <span class="op">=</span><span class="op">></span> <span class="prelude-val">Some</span>(<span class="ident">cmp</span>::<span class="ident">Ordering</span>::<span class="ident">Equal</span>),
(<span class="ident">NormalForm</span>::<span class="ident">ColumnMajorPacked</span>, <span class="ident">NormalForm</span>::<span class="ident">ColumnMajorPacked</span>) <span class="op">=</span><span class="op">></span> <span class="prelude-val">Some</span>(<span class="ident">cmp</span>::<span class="ident">Ordering</span>::<span class="ident">Equal</span>),
(<span class="ident">NormalForm</span>::<span class="ident">Unaliased</span>, <span class="kw">_</span>) <span class="op">=</span><span class="op">></span> <span class="prelude-val">Some</span>(<span class="ident">cmp</span>::<span class="ident">Ordering</span>::<span class="ident">Less</span>),
(<span class="kw">_</span>, <span class="ident">NormalForm</span>::<span class="ident">Unaliased</span>) <span class="op">=</span><span class="op">></span> <span class="prelude-val">Some</span>(<span class="ident">cmp</span>::<span class="ident">Ordering</span>::<span class="ident">Greater</span>),
(<span class="ident">NormalForm</span>::<span class="ident">PixelPacked</span>, <span class="ident">NormalForm</span>::<span class="ident">ColumnMajorPacked</span>) <span class="op">=</span><span class="op">></span> <span class="prelude-val">Some</span>(<span class="ident">cmp</span>::<span class="ident">Ordering</span>::<span class="ident">Less</span>),
(<span class="ident">NormalForm</span>::<span class="ident">PixelPacked</span>, <span class="ident">NormalForm</span>::<span class="ident">RowMajorPacked</span>) <span class="op">=</span><span class="op">></span> <span class="prelude-val">Some</span>(<span class="ident">cmp</span>::<span class="ident">Ordering</span>::<span class="ident">Less</span>),
(<span class="ident">NormalForm</span>::<span class="ident">RowMajorPacked</span>, <span class="ident">NormalForm</span>::<span class="ident">PixelPacked</span>) <span class="op">=</span><span class="op">></span> <span class="prelude-val">Some</span>(<span class="ident">cmp</span>::<span class="ident">Ordering</span>::<span class="ident">Greater</span>),
(<span class="ident">NormalForm</span>::<span class="ident">ColumnMajorPacked</span>, <span class="ident">NormalForm</span>::<span class="ident">PixelPacked</span>) <span class="op">=</span><span class="op">></span> <span class="prelude-val">Some</span>(<span class="ident">cmp</span>::<span class="ident">Ordering</span>::<span class="ident">Greater</span>),
(<span class="ident">NormalForm</span>::<span class="ident">ImagePacked</span>, <span class="ident">NormalForm</span>::<span class="ident">ColumnMajorPacked</span>) <span class="op">=</span><span class="op">></span> <span class="prelude-val">Some</span>(<span class="ident">cmp</span>::<span class="ident">Ordering</span>::<span class="ident">Less</span>),
(<span class="ident">NormalForm</span>::<span class="ident">ImagePacked</span>, <span class="ident">NormalForm</span>::<span class="ident">RowMajorPacked</span>) <span class="op">=</span><span class="op">></span> <span class="prelude-val">Some</span>(<span class="ident">cmp</span>::<span class="ident">Ordering</span>::<span class="ident">Less</span>),
(<span class="ident">NormalForm</span>::<span class="ident">RowMajorPacked</span>, <span class="ident">NormalForm</span>::<span class="ident">ImagePacked</span>) <span class="op">=</span><span class="op">></span> <span class="prelude-val">Some</span>(<span class="ident">cmp</span>::<span class="ident">Ordering</span>::<span class="ident">Greater</span>),
(<span class="ident">NormalForm</span>::<span class="ident">ColumnMajorPacked</span>, <span class="ident">NormalForm</span>::<span class="ident">ImagePacked</span>) <span class="op">=</span><span class="op">></span> <span class="prelude-val">Some</span>(<span class="ident">cmp</span>::<span class="ident">Ordering</span>::<span class="ident">Greater</span>),
(<span class="ident">NormalForm</span>::<span class="ident">ImagePacked</span>, <span class="ident">NormalForm</span>::<span class="ident">PixelPacked</span>) <span class="op">=</span><span class="op">></span> <span class="prelude-val">None</span>,
(<span class="ident">NormalForm</span>::<span class="ident">PixelPacked</span>, <span class="ident">NormalForm</span>::<span class="ident">ImagePacked</span>) <span class="op">=</span><span class="op">></span> <span class="prelude-val">None</span>,
(<span class="ident">NormalForm</span>::<span class="ident">RowMajorPacked</span>, <span class="ident">NormalForm</span>::<span class="ident">ColumnMajorPacked</span>) <span class="op">=</span><span class="op">></span> <span class="prelude-val">None</span>,
(<span class="ident">NormalForm</span>::<span class="ident">ColumnMajorPacked</span>, <span class="ident">NormalForm</span>::<span class="ident">RowMajorPacked</span>) <span class="op">=</span><span class="op">></span> <span class="prelude-val">None</span>,
}
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="kw">mod</span> <span class="ident">tests</span> {
<span class="kw">use</span> <span class="kw">super</span>::<span class="kw-2">*</span>;
<span class="kw">use</span> <span class="ident">buffer</span>::<span class="ident">GrayAlphaImage</span>;
<span class="kw">use</span> <span class="ident">color</span>::{<span class="ident">LumaA</span>, <span class="ident">Rgb</span>};
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">aliasing_view</span>() {
<span class="kw">let</span> <span class="ident">buffer</span> <span class="op">=</span> <span class="ident">FlatSamples</span> {
<span class="ident">samples</span>: <span class="kw-2">&</span>[<span class="number">42</span>],
<span class="ident">layout</span>: <span class="ident">SampleLayout</span> {
<span class="ident">channels</span>: <span class="number">3</span>,
<span class="ident">channel_stride</span>: <span class="number">0</span>,
<span class="ident">width</span>: <span class="number">100</span>,
<span class="ident">width_stride</span>: <span class="number">0</span>,
<span class="ident">height</span>: <span class="number">100</span>,
<span class="ident">height_stride</span>: <span class="number">0</span>,
},
<span class="ident">color_hint</span>: <span class="prelude-val">None</span>,
};
<span class="kw">let</span> <span class="ident">view</span> <span class="op">=</span> <span class="ident">buffer</span>.<span class="ident">as_view</span>::<span class="op"><</span><span class="ident">Rgb</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span><span class="op">></span>()
.<span class="ident">expect</span>(<span class="string">"This is a valid view"</span>);
<span class="kw">let</span> <span class="ident">pixel_count</span> <span class="op">=</span> <span class="ident">view</span>.<span class="ident">pixels</span>()
.<span class="ident">inspect</span>(<span class="op">|</span><span class="ident">pixel</span><span class="op">|</span> <span class="macro">assert</span><span class="macro">!</span>(<span class="ident">pixel</span>.<span class="number">2</span> <span class="op">=</span><span class="op">=</span> <span class="ident">Rgb</span>([<span class="number">42</span>, <span class="number">42</span>, <span class="number">42</span>])))
.<span class="ident">count</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">pixel_count</span>, <span class="number">100</span><span class="kw-2">*</span><span class="number">100</span>);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">mutable_view</span>() {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buffer</span> <span class="op">=</span> <span class="ident">FlatSamples</span> {
<span class="ident">samples</span>: [<span class="number">0</span>; <span class="number">18</span>],
<span class="ident">layout</span>: <span class="ident">SampleLayout</span> {
<span class="ident">channels</span>: <span class="number">2</span>,
<span class="ident">channel_stride</span>: <span class="number">1</span>,
<span class="ident">width</span>: <span class="number">3</span>,
<span class="ident">width_stride</span>: <span class="number">2</span>,
<span class="ident">height</span>: <span class="number">3</span>,
<span class="ident">height_stride</span>: <span class="number">6</span>,
},
<span class="ident">color_hint</span>: <span class="prelude-val">None</span>,
};
{
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">view</span> <span class="op">=</span> <span class="ident">buffer</span>.<span class="ident">as_view_mut</span>::<span class="op"><</span><span class="ident">LumaA</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span><span class="op">></span>()
.<span class="ident">expect</span>(<span class="string">"This should be a valid mutable buffer"</span>);
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">deprecated</span>)]</span>
<span class="kw">let</span> <span class="ident">pixel_count</span> <span class="op">=</span> <span class="ident">view</span>.<span class="ident">pixels_mut</span>()
.<span class="ident">enumerate</span>()
.<span class="ident">map</span>(<span class="op">|</span>(<span class="ident">idx</span>, (<span class="kw">_</span>, <span class="kw">_</span>, <span class="ident">pixel</span>))<span class="op">|</span> <span class="kw-2">*</span><span class="ident">pixel</span> <span class="op">=</span> <span class="ident">LumaA</span>([<span class="number">2</span><span class="kw-2">*</span><span class="ident">idx</span>, <span class="number">2</span><span class="kw-2">*</span><span class="ident">idx</span> <span class="op">+</span> <span class="number">1</span>]))
.<span class="ident">count</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">pixel_count</span>, <span class="number">9</span>);
}
<span class="ident">buffer</span>.<span class="ident">samples</span>.<span class="ident">iter</span>()
.<span class="ident">enumerate</span>()
.<span class="ident">for_each</span>(<span class="op">|</span>(<span class="ident">idx</span>, <span class="ident">sample</span>)<span class="op">|</span> <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">idx</span>, <span class="kw-2">*</span><span class="ident">sample</span>));
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">normal_forms</span>() {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">FlatSamples</span> {
<span class="ident">samples</span>: [<span class="number">0u8</span>; <span class="number">0</span>],
<span class="ident">layout</span>: <span class="ident">SampleLayout</span> {
<span class="ident">channels</span>: <span class="number">2</span>,
<span class="ident">channel_stride</span>: <span class="number">1</span>,
<span class="ident">width</span>: <span class="number">3</span>,
<span class="ident">width_stride</span>: <span class="number">9</span>,
<span class="ident">height</span>: <span class="number">3</span>,
<span class="ident">height_stride</span>: <span class="number">28</span>,
},
<span class="ident">color_hint</span>: <span class="prelude-val">None</span>,
}.<span class="ident">is_normal</span>(<span class="ident">NormalForm</span>::<span class="ident">PixelPacked</span>));
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">FlatSamples</span> {
<span class="ident">samples</span>: [<span class="number">0u8</span>; <span class="number">0</span>],
<span class="ident">layout</span>: <span class="ident">SampleLayout</span> {
<span class="ident">channels</span>: <span class="number">2</span>,
<span class="ident">channel_stride</span>: <span class="number">8</span>,
<span class="ident">width</span>: <span class="number">4</span>,
<span class="ident">width_stride</span>: <span class="number">1</span>,
<span class="ident">height</span>: <span class="number">2</span>,
<span class="ident">height_stride</span>: <span class="number">4</span>,
},
<span class="ident">color_hint</span>: <span class="prelude-val">None</span>,
}.<span class="ident">is_normal</span>(<span class="ident">NormalForm</span>::<span class="ident">ImagePacked</span>));
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">FlatSamples</span> {
<span class="ident">samples</span>: [<span class="number">0u8</span>; <span class="number">0</span>],
<span class="ident">layout</span>: <span class="ident">SampleLayout</span> {
<span class="ident">channels</span>: <span class="number">2</span>,
<span class="ident">channel_stride</span>: <span class="number">1</span>,
<span class="ident">width</span>: <span class="number">4</span>,
<span class="ident">width_stride</span>: <span class="number">2</span>,
<span class="ident">height</span>: <span class="number">2</span>,
<span class="ident">height_stride</span>: <span class="number">8</span>,
},
<span class="ident">color_hint</span>: <span class="prelude-val">None</span>,
}.<span class="ident">is_normal</span>(<span class="ident">NormalForm</span>::<span class="ident">RowMajorPacked</span>));
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">FlatSamples</span> {
<span class="ident">samples</span>: [<span class="number">0u8</span>; <span class="number">0</span>],
<span class="ident">layout</span>: <span class="ident">SampleLayout</span> {
<span class="ident">channels</span>: <span class="number">2</span>,
<span class="ident">channel_stride</span>: <span class="number">1</span>,
<span class="ident">width</span>: <span class="number">4</span>,
<span class="ident">width_stride</span>: <span class="number">4</span>,
<span class="ident">height</span>: <span class="number">2</span>,
<span class="ident">height_stride</span>: <span class="number">2</span>,
},
<span class="ident">color_hint</span>: <span class="prelude-val">None</span>,
}.<span class="ident">is_normal</span>(<span class="ident">NormalForm</span>::<span class="ident">ColumnMajorPacked</span>));
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">image_buffer_conversion</span>() {
<span class="kw">let</span> <span class="ident">expected_layout</span> <span class="op">=</span> <span class="ident">SampleLayout</span> {
<span class="ident">channels</span>: <span class="number">2</span>,
<span class="ident">channel_stride</span>: <span class="number">1</span>,
<span class="ident">width</span>: <span class="number">4</span>,
<span class="ident">width_stride</span>: <span class="number">2</span>,
<span class="ident">height</span>: <span class="number">2</span>,
<span class="ident">height_stride</span>: <span class="number">8</span>,
};
<span class="kw">let</span> <span class="ident">initial</span> <span class="op">=</span> <span class="ident">GrayAlphaImage</span>::<span class="ident">new</span>(<span class="ident">expected_layout</span>.<span class="ident">width</span>, <span class="ident">expected_layout</span>.<span class="ident">height</span>);
<span class="kw">let</span> <span class="ident">buffer</span> <span class="op">=</span> <span class="ident">initial</span>.<span class="ident">into_flat_samples</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">buffer</span>.<span class="ident">layout</span>, <span class="ident">expected_layout</span>);
<span class="kw">let</span> <span class="kw">_</span>: <span class="ident">GrayAlphaImage</span> <span class="op">=</span> <span class="ident">buffer</span>.<span class="ident">try_into_buffer</span>().<span class="ident">unwrap_or_else</span>(<span class="op">|</span>(<span class="ident">error</span>, <span class="kw">_</span>)<span class="op">|</span>
<span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Expected buffer to be convertible but {:?}"</span>, <span class="ident">error</span>));
}
}
</pre></div>
</section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "image";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script><script defer src="../../search-index.js"></script></body></html>