mitchellhansen/Trac3r-rust
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

add doc

Browse Source
This commit is contained in:
mitchellhansen
2020-01-23 23:13:36 -08:00
parent dcc0df955e
commit 2bc9ebdc6b
31829 changed files with 1229378 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

271
doc/src/andrew/lib.rs.html Normal file
View File

@@ -0,0 +1,271 @@
<!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/andrew-0.2.1/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.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">&#9776;</div><a href='../../andrew/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>
</pre><div class="example-wrap"><pre class="rust ">
<span class="doccomment">//! Andrew is a crate for drawing objects</span>
<span class="attribute">#![<span class="ident">warn</span>(<span class="ident">missing_docs</span>)]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">line_drawing</span>;
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">rusttype</span>;
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">walkdir</span>;
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">xdg</span>;
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">xml</span>;
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">bitflags</span>;
<span class="doccomment">/// A module that contains functions and objects relating to lines</span>
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">line</span>;
<span class="doccomment">/// A module that contains functions and objects relating to shapes</span>
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">shapes</span>;
<span class="doccomment">/// A module that contains functions and objects relating to text</span>
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">text</span>;
<span class="doccomment">/// The Drawable trait allows object to be drawn to a buffer or canvas</span>
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">Drawable</span> {
<span class="doccomment">/// A function that draws the object to a canvas</span>
<span class="kw">fn</span> <span class="ident">draw</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">canvas</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">Canvas</span>);
}
<span class="doccomment">/// Describes an endianness (aka byte order)</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">PartialEq</span>)]</span>
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">Endian</span> {
<span class="doccomment">/// Little Endian</span>
<span class="ident">Little</span>,
<span class="doccomment">/// Big Endian</span>
<span class="ident">Big</span>,
}
<span class="kw">impl</span> <span class="ident">Endian</span> {
<span class="doccomment">/// Returns the native endianness</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">native</span>() <span class="op">-</span><span class="op">&gt;</span> <span class="ident">Endian</span> {
<span class="kw">if</span> <span class="macro">cfg</span><span class="macro">!</span>(<span class="ident">target_endian</span> <span class="op">=</span> <span class="string">&quot;little&quot;</span>) {
<span class="ident">Endian</span>::<span class="ident">Little</span>
} <span class="kw">else</span> {
<span class="ident">Endian</span>::<span class="ident">Big</span>
}
}
}
<span class="doccomment">/// The canvas object acts as a wrapper around a buffer, providing information and functions</span>
<span class="doccomment">/// for drawing</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Canvas</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span> {
<span class="doccomment">/// A buffer for the canvas to draw to</span>
<span class="kw">pub</span> <span class="ident">buffer</span>: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a</span> <span class="kw-2">mut</span> [<span class="ident">u8</span>],
<span class="doccomment">/// The width in pixels of the canvas</span>
<span class="kw">pub</span> <span class="ident">width</span>: <span class="ident">usize</span>,
<span class="doccomment">/// The height in pixels of the canvas</span>
<span class="kw">pub</span> <span class="ident">height</span>: <span class="ident">usize</span>,
<span class="doccomment">/// The number of bytes between each line of pixels on the canvas</span>
<span class="kw">pub</span> <span class="ident">stride</span>: <span class="ident">usize</span>,
<span class="doccomment">/// The number of bytes contained in each pixel</span>
<span class="kw">pub</span> <span class="ident">pixel_size</span>: <span class="ident">usize</span>,
<span class="doccomment">/// The endianness of the canvas</span>
<span class="kw">pub</span> <span class="ident">endianness</span>: <span class="ident">Endian</span>,
}
<span class="kw">impl</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span> <span class="ident">Canvas</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span> {
<span class="doccomment">/// Creates a new canvas object</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(
<span class="ident">buffer</span>: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a</span> <span class="kw-2">mut</span> [<span class="ident">u8</span>],
<span class="ident">width</span>: <span class="ident">usize</span>,
<span class="ident">height</span>: <span class="ident">usize</span>,
<span class="ident">stride</span>: <span class="ident">usize</span>,
<span class="ident">endianness</span>: <span class="ident">Endian</span>,
) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">Canvas</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span> {
<span class="macro">assert</span><span class="macro">!</span>(
<span class="ident">stride</span> <span class="op">%</span> <span class="ident">width</span> <span class="op">=</span><span class="op">=</span> <span class="number">0</span>,
<span class="string">&quot;Incorrect Dimensions - Stride is not a multiple of width&quot;</span>
);
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">buffer</span>.<span class="ident">len</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">stride</span> <span class="op">*</span> <span class="ident">height</span>);
<span class="kw">let</span> <span class="ident">pixel_size</span> <span class="op">=</span> <span class="ident">stride</span> <span class="op">/</span> <span class="ident">width</span>;
<span class="ident">Canvas</span> {
<span class="ident">buffer</span>,
<span class="ident">width</span>,
<span class="ident">height</span>,
<span class="ident">stride</span>,
<span class="ident">pixel_size</span>,
<span class="ident">endianness</span>,
}
}
<span class="doccomment">/// Draws an object that implements the Drawable trait to the buffer</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">draw</span><span class="op">&lt;</span><span class="ident">D</span>: <span class="ident">Drawable</span><span class="op">&gt;</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">drawable</span>: <span class="kw-2">&amp;</span><span class="ident">D</span>) {
<span class="ident">drawable</span>.<span class="ident">draw</span>(<span class="self">self</span>);
}
<span class="doccomment">/// Draws a pixel at the x and y coordinate</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">draw_point</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">x</span>: <span class="ident">usize</span>, <span class="ident">y</span>: <span class="ident">usize</span>, <span class="ident">color</span>: [<span class="ident">u8</span>; <span class="number">4</span>]) {
<span class="kw">let</span> <span class="ident">base</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">stride</span> <span class="op">*</span> <span class="ident">y</span> <span class="op">+</span> <span class="self">self</span>.<span class="ident">pixel_size</span> <span class="op">*</span> <span class="ident">x</span>;
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">endianness</span> <span class="op">=</span><span class="op">=</span> <span class="ident">Endian</span>::<span class="ident">Little</span> {
<span class="kw">if</span> <span class="ident">color</span>[<span class="number">0</span>] <span class="op">=</span><span class="op">=</span> <span class="number">255</span> {
<span class="self">self</span>.<span class="ident">buffer</span>[<span class="ident">base</span> <span class="op">+</span> <span class="number">3</span>] <span class="op">=</span> <span class="ident">color</span>[<span class="number">0</span>];
<span class="self">self</span>.<span class="ident">buffer</span>[<span class="ident">base</span> <span class="op">+</span> <span class="number">2</span>] <span class="op">=</span> <span class="ident">color</span>[<span class="number">1</span>];
<span class="self">self</span>.<span class="ident">buffer</span>[<span class="ident">base</span> <span class="op">+</span> <span class="number">1</span>] <span class="op">=</span> <span class="ident">color</span>[<span class="number">2</span>];
<span class="self">self</span>.<span class="ident">buffer</span>[<span class="ident">base</span>] <span class="op">=</span> <span class="ident">color</span>[<span class="number">3</span>];
} <span class="kw">else</span> {
<span class="kw">for</span> <span class="ident">c</span> <span class="kw">in</span> <span class="number">0</span>..<span class="number">3</span> {
<span class="kw">let</span> <span class="ident">alpha</span> <span class="op">=</span> <span class="ident">f32</span>::<span class="ident">from</span>(<span class="ident">color</span>[<span class="number">0</span>]) <span class="op">/</span> <span class="number">255.0</span>;
<span class="kw">let</span> <span class="ident">color_diff</span> <span class="op">=</span>
(<span class="ident">color</span>[<span class="number">3</span> <span class="op">-</span> <span class="ident">c</span>] <span class="kw">as</span> <span class="ident">isize</span> <span class="op">-</span> <span class="self">self</span>.<span class="ident">buffer</span>[<span class="ident">base</span> <span class="op">+</span> <span class="ident">c</span>] <span class="kw">as</span> <span class="ident">isize</span>) <span class="kw">as</span> <span class="ident">f32</span> <span class="op">*</span> <span class="ident">alpha</span>;
<span class="kw">let</span> <span class="ident">new_color</span> <span class="op">=</span> (<span class="ident">f32</span>::<span class="ident">from</span>(<span class="self">self</span>.<span class="ident">buffer</span>[<span class="ident">base</span> <span class="op">+</span> <span class="ident">c</span>]) <span class="op">+</span> <span class="ident">color_diff</span>) <span class="kw">as</span> <span class="ident">u8</span>;
<span class="self">self</span>.<span class="ident">buffer</span>[<span class="ident">base</span> <span class="op">+</span> <span class="ident">c</span>] <span class="op">=</span> <span class="ident">new_color</span> <span class="kw">as</span> <span class="ident">u8</span>;
}
<span class="self">self</span>.<span class="ident">buffer</span>[<span class="ident">base</span> <span class="op">+</span> <span class="number">3</span>] <span class="op">=</span> <span class="number">255</span> <span class="kw">as</span> <span class="ident">u8</span>;
}
} <span class="kw">else</span> <span class="kw">if</span> <span class="ident">color</span>[<span class="number">0</span>] <span class="op">=</span><span class="op">=</span> <span class="number">255</span> {
<span class="self">self</span>.<span class="ident">buffer</span>[<span class="ident">base</span>] <span class="op">=</span> <span class="ident">color</span>[<span class="number">0</span>];
<span class="self">self</span>.<span class="ident">buffer</span>[<span class="ident">base</span> <span class="op">+</span> <span class="number">1</span>] <span class="op">=</span> <span class="ident">color</span>[<span class="number">1</span>];
<span class="self">self</span>.<span class="ident">buffer</span>[<span class="ident">base</span> <span class="op">+</span> <span class="number">2</span>] <span class="op">=</span> <span class="ident">color</span>[<span class="number">2</span>];
<span class="self">self</span>.<span class="ident">buffer</span>[<span class="ident">base</span> <span class="op">+</span> <span class="number">3</span>] <span class="op">=</span> <span class="ident">color</span>[<span class="number">3</span>];
} <span class="kw">else</span> {
<span class="kw">for</span> <span class="ident">c</span> <span class="kw">in</span> <span class="number">1</span>..<span class="number">4</span> {
<span class="kw">let</span> <span class="ident">alpha</span> <span class="op">=</span> <span class="ident">f32</span>::<span class="ident">from</span>(<span class="ident">color</span>[<span class="number">0</span>]) <span class="op">/</span> <span class="number">255.0</span>;
<span class="kw">let</span> <span class="ident">color_diff</span> <span class="op">=</span>
(<span class="ident">color</span>[<span class="ident">c</span>] <span class="kw">as</span> <span class="ident">isize</span> <span class="op">-</span> <span class="self">self</span>.<span class="ident">buffer</span>[<span class="ident">base</span> <span class="op">+</span> <span class="ident">c</span>] <span class="kw">as</span> <span class="ident">isize</span>) <span class="kw">as</span> <span class="ident">f32</span> <span class="op">*</span> <span class="ident">alpha</span>;
<span class="kw">let</span> <span class="ident">new_color</span> <span class="op">=</span> (<span class="ident">f32</span>::<span class="ident">from</span>(<span class="self">self</span>.<span class="ident">buffer</span>[<span class="ident">base</span> <span class="op">+</span> <span class="ident">c</span>]) <span class="op">+</span> <span class="ident">color_diff</span>) <span class="kw">as</span> <span class="ident">u8</span>;
<span class="self">self</span>.<span class="ident">buffer</span>[<span class="ident">base</span> <span class="op">+</span> <span class="ident">c</span>] <span class="op">=</span> <span class="ident">new_color</span> <span class="kw">as</span> <span class="ident">u8</span>;
}
<span class="self">self</span>.<span class="ident">buffer</span>[<span class="ident">base</span>] <span class="op">=</span> <span class="number">255</span> <span class="kw">as</span> <span class="ident">u8</span>;
}
}
<span class="doccomment">/// Clears the entire canvas buffer by zeroing it</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">clear</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>) {
<span class="kw">for</span> <span class="ident">i</span> <span class="kw">in</span> <span class="number">0</span>..<span class="self">self</span>.<span class="ident">width</span> <span class="op">*</span> <span class="self">self</span>.<span class="ident">height</span> <span class="op">*</span> <span class="number">4</span> {
<span class="self">self</span>.<span class="ident">buffer</span>[<span class="ident">i</span>] <span class="op">=</span> <span class="number">0x00</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>&#9166;</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 = "andrew";</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>