<!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/hasufell/.cargo/registry/src/github.com-1ecc6299db9ec823/png-0.9.0/src/chunk.rs`."> <meta name="keywords" content="rust, rustlang, rust-lang"> <title>chunk.rs.html -- source</title> <link rel="stylesheet" type="text/css" href="../../normalize.css"> <link rel="stylesheet" type="text/css" href="../../rustdoc.css"> <link rel="stylesheet" type="text/css" href="../../main.css"> </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"> </nav> <nav class="sub"> <form class="search-form js-only"> <div class="search-container"> <input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"> </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> </pre><pre class="rust "> <span class="doccomment">//! Chunk types and functions</span> <span class="attribute">#<span class="op">!</span>[<span class="ident">allow</span>(<span class="ident">dead_code</span>)]</span> <span class="attribute">#<span class="op">!</span>[<span class="ident">allow</span>(<span class="ident">non_upper_case_globals</span>)]</span> <span class="kw">pub</span> <span class="kw">type</span> <span class="ident">ChunkType</span> <span class="op">=</span> [<span class="ident">u8</span>; <span class="number">4</span>]; <span class="comment">// -- Critical chunks --</span> <span class="doccomment">/// Image header</span> <span class="kw">pub</span> <span class="kw">const</span> <span class="ident">IHDR</span>: <span class="ident">ChunkType</span> <span class="op">=</span> [<span class="string">b'I'</span>, <span class="string">b'H'</span>, <span class="string">b'D'</span>, <span class="string">b'R'</span>]; <span class="doccomment">/// Palette</span> <span class="kw">pub</span> <span class="kw">const</span> <span class="ident">PLTE</span>: <span class="ident">ChunkType</span> <span class="op">=</span> [<span class="string">b'P'</span>, <span class="string">b'L'</span>, <span class="string">b'T'</span>, <span class="string">b'E'</span>]; <span class="doccomment">/// Image data</span> <span class="kw">pub</span> <span class="kw">const</span> <span class="ident">IDAT</span>: <span class="ident">ChunkType</span> <span class="op">=</span> [<span class="string">b'I'</span>, <span class="string">b'D'</span>, <span class="string">b'A'</span>, <span class="string">b'T'</span>]; <span class="doccomment">/// Image trailer</span> <span class="kw">pub</span> <span class="kw">const</span> <span class="ident">IEND</span>: <span class="ident">ChunkType</span> <span class="op">=</span> [<span class="string">b'I'</span>, <span class="string">b'E'</span>, <span class="string">b'N'</span>, <span class="string">b'D'</span>]; <span class="comment">// -- Ancillary chunks --</span> <span class="doccomment">/// Transparency</span> <span class="kw">pub</span> <span class="kw">const</span> <span class="ident">tRNS</span>: <span class="ident">ChunkType</span> <span class="op">=</span> [<span class="string">b't'</span>, <span class="string">b'R'</span>, <span class="string">b'N'</span>, <span class="string">b'S'</span>]; <span class="doccomment">/// Background colour</span> <span class="kw">pub</span> <span class="kw">const</span> <span class="ident">bKGD</span>: <span class="ident">ChunkType</span> <span class="op">=</span> [<span class="string">b'b'</span>, <span class="string">b'K'</span>, <span class="string">b'G'</span>, <span class="string">b'D'</span>]; <span class="doccomment">/// Image last-modification time</span> <span class="kw">pub</span> <span class="kw">const</span> <span class="ident">tIME</span>: <span class="ident">ChunkType</span> <span class="op">=</span> [<span class="string">b't'</span>, <span class="string">b'I'</span>, <span class="string">b'M'</span>, <span class="string">b'E'</span>]; <span class="doccomment">/// Physical pixel dimensions</span> <span class="kw">pub</span> <span class="kw">const</span> <span class="ident">pHYs</span>: <span class="ident">ChunkType</span> <span class="op">=</span> [<span class="string">b'p'</span>, <span class="string">b'H'</span>, <span class="string">b'Y'</span>, <span class="string">b's'</span>]; <span class="comment">// -- Extension chunks --</span> <span class="doccomment">/// Animation control</span> <span class="kw">pub</span> <span class="kw">const</span> <span class="ident">acTL</span>: <span class="ident">ChunkType</span> <span class="op">=</span> [<span class="string">b'a'</span>, <span class="string">b'c'</span>, <span class="string">b'T'</span>, <span class="string">b'L'</span>]; <span class="doccomment">/// Frame control</span> <span class="kw">pub</span> <span class="kw">const</span> <span class="ident">fcTL</span>: <span class="ident">ChunkType</span> <span class="op">=</span> [<span class="string">b'f'</span>, <span class="string">b'c'</span>, <span class="string">b'T'</span>, <span class="string">b'L'</span>]; <span class="doccomment">/// Frame data</span> <span class="kw">pub</span> <span class="kw">const</span> <span class="ident">fdAT</span>: <span class="ident">ChunkType</span> <span class="op">=</span> [<span class="string">b'f'</span>, <span class="string">b'd'</span>, <span class="string">b'A'</span>, <span class="string">b'T'</span>]; <span class="comment">// -- Chunk type determination --</span> <span class="doccomment">/// Returns true if the chunk is critical.</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">is_critical</span>(<span class="ident">type_</span>: <span class="ident">ChunkType</span>) <span class="op">-></span> <span class="ident">bool</span> { <span class="ident">type_</span>[<span class="number">0</span>] <span class="op">&</span> <span class="number">32</span> <span class="op">==</span> <span class="number">0</span> } <span class="doccomment">/// Returns true if the chunk is private.</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">is_private</span>(<span class="ident">type_</span>: <span class="ident">ChunkType</span>) <span class="op">-></span> <span class="ident">bool</span> { <span class="ident">type_</span>[<span class="number">1</span>] <span class="op">&</span> <span class="number">32</span> <span class="op">!=</span> <span class="number">0</span> } <span class="doccomment">/// Checks whether the reserved bit of the chunk name is set.</span> <span class="doccomment">/// If it is set the chunk name is invalid.</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">reserved_set</span>(<span class="ident">type_</span>: <span class="ident">ChunkType</span>) <span class="op">-></span> <span class="ident">bool</span> { <span class="ident">type_</span>[<span class="number">2</span>] <span class="op">&</span> <span class="number">32</span> <span class="op">!=</span> <span class="number">0</span> } <span class="doccomment">/// Returns true if the chunk is safe to copy if unknown.</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">safe_to_copy</span>(<span class="ident">type_</span>: <span class="ident">ChunkType</span>) <span class="op">-></span> <span class="ident">bool</span> { <span class="ident">type_</span>[<span class="number">3</span>] <span class="op">&</span> <span class="number">32</span> <span class="op">!=</span> <span class="number">0</span> }</pre> </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>?</dt> <dd>Show this help dialog</dd> <dt>S</dt> <dd>Focus the search field</dd> <dt>⇤</dt> <dd>Move up in search results</dd> <dt>⇥</dt> <dd>Move down in search results</dd> <dt>⏎</dt> <dd>Go to active search result</dd> <dt>+</dt> <dd>Collapse/expand 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> </div> </div> </aside> <script> window.rootPath = "../../"; window.currentCrate = "png"; </script> <script src="../../main.js"></script> <script defer src="../../search-index.js"></script> </body> </html>