f3-rs/f3_rs/index.html

27 lines
No EOL
10 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Welcome to F3 Documentation!"><meta name="keywords" content="rust, rustlang, rust-lang, f3_rs"><title>f3_rs - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.js"></script><script defer src="../main.js"></script>
<noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../f3_rs/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"></h2>
</nav>
<nav class="sidebar"><a class="sidebar-logo" href="../f3_rs/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"><a href="#">Crate f3_rs</a></h2><div class="sidebar-elems"><div class="block"><ul><li class="version">Version 0.1.0</li><li><a id="all-types" href="all.html">All Items</a></li></div></ul><section><div class="block"><ul><li><a href="#modules">Modules</a></li><li><a href="#enums">Enums</a></li></ul></div></section><div id="sidebar-vars" data-name="f3_rs" data-ty="mod" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../f3_rs/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
<h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">f3_rs</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/f3_rs/lib.rs.html#17-60">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><h2 id="welcome-to-f3-documentation"><a href="#welcome-to-f3-documentation">Welcome to F3 Documentation!</a></h2>
<p>Please refer to the <a href="https://f3.forgefriends.org/">main documentation</a> for a complete overview.
This is an incomplete Rust port of the F3 library created by the ForgeFriends project.</p>
</div></details><h2 id="reexports" class="small-section-header"><a href="#reexports">Re-exports</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left import-item"><code>pub use comment::<a class="struct" href="comment/struct.Comment.html" title="struct f3_rs::comment::Comment">Comment</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use identities::<a class="struct" href="identities/struct.Identities.html" title="struct f3_rs::identities::Identities">Identities</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use issue::<a class="struct" href="issue/struct.Issue.html" title="struct f3_rs::issue::Issue">Issue</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use label::<a class="struct" href="label/struct.Label.html" title="struct f3_rs::label::Label">Label</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use milestone::<a class="struct" href="milestone/struct.Milestone.html" title="struct f3_rs::milestone::Milestone">Milestone</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use project::<a class="struct" href="project/struct.Project.html" title="struct f3_rs::project::Project">Project</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use reaction::<a class="struct" href="reaction/struct.Reaction.html" title="struct f3_rs::reaction::Reaction">Reaction</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use repository::<a class="struct" href="repository/struct.Repository.html" title="struct f3_rs::repository::Repository">Repository</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use topic::<a class="struct" href="topic/struct.Topic.html" title="struct f3_rs::topic::Topic">Topic</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use user::<a class="struct" href="user/struct.User.html" title="struct f3_rs::user::User">User</a>;</code></div><div class="item-right docblock-short"></div></div></div><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="comment/index.html" title="f3_rs::comment mod">comment</a></div><div class="item-right docblock-short"><p>Comments associated to an issue or a pull/merge request within the repository of a forge
(Gitea, GitLab, etc.)</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="identities/index.html" title="f3_rs::identities mod">identities</a></div><div class="item-right docblock-short"><p>Pairs of identities mapping one forge to another.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="issue/index.html" title="f3_rs::issue mod">issue</a></div><div class="item-right docblock-short"><p>Issues associated to a repository within a forge (Gitea, GitLab, etc.).</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="label/index.html" title="f3_rs::label mod">label</a></div><div class="item-right docblock-short"><p>Label associated to an issue or a comment</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="milestone/index.html" title="f3_rs::milestone mod">milestone</a></div><div class="item-right docblock-short"><p>Milestone associated to a repository within a forge</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="project/index.html" title="f3_rs::project mod">project</a></div><div class="item-right docblock-short"><p>A software project that resides on a forge (Gitea, GitLab, etc.).</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="reaction/index.html" title="f3_rs::reaction mod">reaction</a></div><div class="item-right docblock-short"><p>Reaction associated to an issue or a comment</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="repository/index.html" title="f3_rs::repository mod">repository</a></div><div class="item-right docblock-short"><p>VCS repository relative to a project.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="topic/index.html" title="f3_rs::topic mod">topic</a></div><div class="item-right docblock-short"><p>A list of categories associated with a project.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="user/index.html" title="f3_rs::user mod">user</a></div><div class="item-right docblock-short"><p>A forge user</p>
</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.OpenCloseState.html" title="f3_rs::OpenCloseState enum">OpenCloseState</a></div><div class="item-right docblock-short"><p>states of issue, milestone, etc with only “open” and “closed” states and “closed” states and
“closed” states and “closed” states</p>
</div></div></div></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="f3_rs" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.60.0 (7737e0b5c 2022-04-04)" ></div>
</body></html>