github-actions[bot]
35 lines
6.7 KiB
HTML
35 lines
6.7 KiB
HTML
<!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="API documentation for the Rust `rapr` crate."><meta name="keywords" content="rust, rustlang, rust-lang, rapr"><title>rapr - Rust</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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[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='../rapr/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Crate rapr</p><div class="block version"><p>Version 0.1.1</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all rapr's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class="location"></p><div id="sidebar-vars" data-name="rapr" data-ty="mod" data-relpath="../"></div></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<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"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="">rapr</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/rapr/lib.rs.html#1-51" title="goto source code">[src]</a></span></h1><div class="docblock"><h1 id="reddit-api-wrapper" class="section-header"><a href="#reddit-api-wrapper">Reddit api wrapper</a></h1>
|
||
<p>Example program<br />
|
||
You need tokio to use this.<br />
|
||
Make sure to use <code>tokio = { version = "1.3.*", features = ["full"] }</code></p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">rapr</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">tokio</span>;
|
||
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">rapr</span>::{<span class="ident">RaprClient</span>,<span class="ident">RaSub</span>};
|
||
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>]</span>
|
||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">main</span>() <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">rapr</span>::<span class="ident">Error</span><span class="op">></span> {
|
||
<span class="kw">let</span> <span class="ident">client</span> <span class="op">=</span> <span class="ident">RaprClient</span>::<span class="ident">default</span>();
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">sub</span> <span class="op">=</span> <span class="ident">RaSub</span>::<span class="ident">new</span>(<span class="string">"pics"</span>);
|
||
<span class="ident">client</span>.<span class="ident">fetch</span>(<span class="number">10</span>, <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">sub</span>).<span class="kw">await</span><span class="question-mark">?</span>;
|
||
<span class="kw">for</span> <span class="ident">post</span> <span class="kw">in</span> <span class="ident">sub</span>.<span class="ident">posts</span> {
|
||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{}"</span>,<span class="ident">post</span>.<span class="ident">title</span>);
|
||
}
|
||
<span class="prelude-val">Ok</span>(())
|
||
}</pre></div>
|
||
</div><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
|
||
<table><tr class="module-item"><td><a class="struct" href="struct.RaPost.html" title="rapr::RaPost struct">RaPost</a></td><td class="docblock-short"><p>Reddit post object
|
||
(more like repost object).<br />
|
||
Keeps track of post information.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RaPostItems.html" title="rapr::RaPostItems struct">RaPostItems</a></td><td class="docblock-short"><p>Items related to the post</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RaSub.html" title="rapr::RaSub struct">RaSub</a></td><td class="docblock-short"><p>RaSub</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RaprClient.html" title="rapr::RaprClient struct">RaprClient</a></td><td class="docblock-short"><p>Reddit api client.<br />
|
||
Uses a <a href="https://docs.rs/reqwest/0.11.2/reqwest/struct.Client.html">reqwest::Client</a> internally.<br />
|
||
Currently no authentication</p>
|
||
</td></tr></table><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2>
|
||
<table><tr class="module-item"><td><a class="enum" href="enum.Error.html" title="rapr::Error enum">Error</a></td><td class="docblock-short"><p>Error enum</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="rapr"></div>
|
||
<script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |