<!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 `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></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></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"><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><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>
</pre><pre class="rust ">
<span class="doccomment">//! Issue/PR exporter for GitHub.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! # dumplingh as а library</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ## Data flow</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ```plaintext</span>
<span class="doccomment">//! Options::parse()</span>
<span class="doccomment">//! |> list_{pull_requests,issues}()</span>
<span class="doccomment">//! |> save_{to_file,data}()</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ## Example</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//! # use dumplingh::ops::{save_to_file, list_pull_requests};</span>
<span class="doccomment">//! # use std::env::temp_dir;</span>
<span class="doccomment">//! # use std::fs;</span>
<span class="doccomment">//! # /*</span>
<span class="doccomment">//! let out_path = "pulls.json";</span>
<span class="doccomment">//! # */</span>
<span class="doccomment">//! # let mut out_path = temp_dir().join("dumplingh-doctest");</span>
<span class="doccomment">//! # fs::create_dir_all(&out_path).unwrap();</span>
<span class="doccomment">//! # out_path.push("pulls.json");</span>
<span class="doccomment">//! let repo = "nabijaczleweli/cargo-update".parse().unwrap();</span>
<span class="doccomment">//! let pulls = list_pull_requests(&repo, None).unwrap();</span>
<span class="doccomment">//! save_to_file(out_path, &pulls, false, "pull requests").unwrap();</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! # dumplingh as аn executable</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! This is just a very short synopsis of</span>
<span class="doccomment">//! [the manpage](https://rawcdn.githack.com/nabijaczleweli/dumplingh/man/dumplingh.1.html),</span>
<span class="doccomment">//! so consult that for more data.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ## OPTIONS</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! | Option | Description |</span>
<span class="doccomment">//! |--------------------------------------|--------------------------------------------------------------------------|</span>
<span class="doccomment">//! | &lt;REPO_SLUG&gt; | Repository to export issues and PRs for in the form `<username>/<repo>`. |</span>
<span class="doccomment">//! | --issues &lt;ISSUES_FILE&gt; | File to export issues to, or `./<slug>-issues.json` by default. |</span>
<span class="doccomment">//! | --pulls &lt;PULLS_FILE&gt; | File to export pull requests to, or `./<slug>-pulls.json` by default. |</span>
<span class="doccomment">//! | --labels &lt;LABELS_FILE&gt; | File to export labels to, or `./<slug>-labels.json` by default. |</span>
<span class="doccomment">//! | --milestones &lt;MILESTONES_FILE&gt; | File to export milestones to, or `./<slug>-milestones.json` by default. |</span>
<span class="doccomment">//! | --projects &lt;PROJECTS_FILE&gt; | File to export projects to, or `./<slug>-projects.json` by default. |</span>
<span class="doccomment">//! | --comments &lt;COMMENTS_DIR&gt; | Directory to export comments to, or `./<slug>-comments` by default. |</span>
<span class="doccomment">//! | --auth [AUTH_TOKEN] | GitHub OAuth2 token, required for projects. |</span>
<span class="doccomment">//! | --no-issues | Don't export issues. |</span>
<span class="doccomment">//! | --no-pulls | Don't export pull requests. |</span>
<span class="doccomment">//! | --no-labels | Don't export labels. |</span>
<span class="doccomment">//! | --no-milestones | Don't export milestones. |</span>
<span class="doccomment">//! | --no-projects | Don't export projects. |</span>
<span class="doccomment">//! | --no-comments | Don't export comments. |</span>
<span class="doccomment">//! | --force | Override existing files. |</span>
<span class="doccomment">//! | --compact | Don't pretty-print exported JSON. |</span>
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">lazy_static</span>;
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">serde_json</span>;
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">reqwest</span>;
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">serde</span>;
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">clap</span>;
<span class="kw">mod</span> <span class="ident">error</span>;
<span class="kw">mod</span> <span class="ident">options</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">ops</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">util</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">error</span>::<span class="ident">Error</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">options</span>::<span class="ident">Options</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><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 = "dumplingh";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>