f3-rs/f3_rs/index.html

6 lines
11 KiB
HTML
Raw Normal View History

2023-10-24 20:04:24 +05:30
<!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!"><title>f3_rs - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-cb6f1f67f1bcd037.css" id="mainThemeStyle"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="f3_rs" data-themes="" data-resource-suffix="" data-rustdoc-version="1.73.0 (cc66ad468 2023-10-03)" data-channel="1.73.0" data-search-js="search-6dfdfced5eff6596.js" data-settings-js="settings-de11bff964e9d4e5.js" data-settings-css="settings-8c76f75bfb6bd192.css" data-theme-light-css="light-1596385f77d47ef2.css" data-theme-dark-css="dark-0a43001d3fc2282c.css" data-theme-ayu-css="ayu-fd19013d6ce078bf.css" ><script src="../static.files/storage-db41da1a38ea3cb8.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-0795b7d26be81095.js"></script><noscript><link rel="stylesheet" media="(prefers-color-scheme:light)" href="../static.files/light-1596385f77d47ef2.css"><link rel="stylesheet" media="(prefers-color-scheme:dark)" href="../static.files/dark-0a43001d3fc2282c.css"><link rel="stylesheet" href="../static.files/noscript-cffde32267a19fd6.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.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="logo-container" href="../f3_rs/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2></h2></nav><nav class="sidebar"><a class="logo-container" href="../f3_rs/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">Crate f3_rs</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 0.1.0</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#enums">Enums</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="
2023-01-02 22:40:34 +05:30
<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>
2023-10-24 19:50:11 +05:30
</div></details><h2 id="reexports" class="small-section-header"><a href="#reexports">Re-exports</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.Comment"><code>pub use comment::<a class="struct" href="comment/struct.Comment.html" title="struct f3_rs::comment::Comment">Comment</a>;</code></div></li><li><div class="item-name" id="reexport.Identities"><code>pub use identities::<a class="struct" href="identities/struct.Identities.html" title="struct f3_rs::identities::Identities">Identities</a>;</code></div></li><li><div class="item-name" id="reexport.Issue"><code>pub use issue::<a class="struct" href="issue/struct.Issue.html" title="struct f3_rs::issue::Issue">Issue</a>;</code></div></li><li><div class="item-name" id="reexport.Label"><code>pub use label::<a class="struct" href="label/struct.Label.html" title="struct f3_rs::label::Label">Label</a>;</code></div></li><li><div class="item-name" id="reexport.Milestone"><code>pub use milestone::<a class="struct" href="milestone/struct.Milestone.html" title="struct f3_rs::milestone::Milestone">Milestone</a>;</code></div></li><li><div class="item-name" id="reexport.Project"><code>pub use project::<a class="struct" href="project/struct.Project.html" title="struct f3_rs::project::Project">Project</a>;</code></div></li><li><div class="item-name" id="reexport.PullRequest"><code>pub use pullrequest::<a class="struct" href="pullrequest/struct.PullRequest.html" title="struct f3_rs::pullrequest::PullRequest">PullRequest</a>;</code></div></li><li><div class="item-name" id="reexport.Reaction"><code>pub use reaction::<a class="struct" href="reaction/struct.Reaction.html" title="struct f3_rs::reaction::Reaction">Reaction</a>;</code></div></li><li><div class="item-name" id="reexport.Release"><code>pub use release::<a class="struct" href="release/struct.Release.html" title="struct f3_rs::release::Release">Release</a>;</code></div></li><li><div class="item-name" id="reexport.ReleaseAsset"><code>pub use release::<a class="struct" href="release/struct.ReleaseAsset.html" title="struct f3_rs::release::ReleaseAsset">ReleaseAsset</a>;</code></div></li><li><div class="item-name" id="reexport.Repository"><code>pub use repository::<a class="struct" href="repository/struct.Repository.html" title="struct f3_rs::repository::Repository">Repository</a>;</code></div></li><li><div class="item-name" id="reexport.Review"><code>pub use review::<a class="struct" href="review/struct.Review.html" title="struct f3_rs::review::Review">Review</a>;</code></div></li><li><div class="item-name" id="reexport.ReviewComment"><code>pub use review::<a class="struct" href="review/struct.ReviewComment.html" title="struct f3_rs::review::ReviewComment">ReviewComment</a>;</code></div></li><li><div class="item-name" id="reexport.ReviewState"><code>pub use review::<a class="enum" href="review/enum.ReviewState.html" title="enum f3_rs::review::ReviewState">ReviewState</a>;</code></div></li><li><div class="item-name" id="reexport.Topic"><code>pub use topic::<a class="struct" href="topic/struct.Topic.html" title="struct f3_rs::topic::Topic">Topic</a>;</code></div></li><li><div class="item-name" id="reexport.User"><code>pub use user::<a class="struct" href="user/struct.User.html" title="struct f3_rs::user::User">User</a>;</code></div></li></ul><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="comment/index.html" title="mod f3_rs::comment">comment</a></div><div class="desc docblock-short">Comments associated to an issue or a pull/merge request within the repository of a forge
(Gitea, GitLab, etc.)</div></li><li><div class="item-name"><a class="mod" href="identities/index.html" title="mod f3_rs::identities">identities</a></div><div class="desc docblock-short">Pairs of identities mapping one forge to another.</div></li><li><div class="item-name"><a class="mod" href="issue/index.html" title="mod f3_rs::issue">issue</a></div><div class="desc docblock-short">Issues associated to a repository within a forge (Gitea, GitLab, etc.).</div></li><li><div class="item-name"><a class="mod" href="label/index.html" title="mod f3_rs::label">label</a></div><div class="desc docblock-short">Label associated to an issue or a comment</div></li><li><div class="item-name"><a class="mod" href="milestone/index.html" title="mod f3_rs::milestone">milestone</a></div><div class="desc docblock-short">Milestone associated to a repository within a forge</div></li><li><div class="item-name"><a class="mod" href="project/index.html" title="mod f3_rs::project">project</a></div><div class="desc docblock-short">A software project that resides on a forge (Gitea, GitLab, etc.).</div></li><li><div class="item-name"><a class="mod" href="pullrequest/index.html" title="mod f3_rs::pullrequest">pullrequest</a></div><div class="desc docblock-short">Pull requests associated to a repository within a forge (Gitea, GitLab, etc.)</div></li><li><div class="item-name"><a class="mod" href="reaction/index.html" title="mod f3_rs::reaction">reaction</a></div><div class="desc docblock-short">Reaction associated to an issue or a comment</div></li><li><div class="item-name"><a class="mod" href="release/index.html" title="mod f3_rs::release">release</a></div><div class="desc docblock-short">Assets that constitute a release for a given tag.</div></li><li><div class="item-name"><a class="mod" href="repository/index.html" title="mod f3_rs::repository">repository</a></div><div class="desc docblock-short">VCS repository relative to a project.</div></li><li><div class="item-name"><a class="mod" href="review/index.html" title="mod f3_rs::review">review</a></div><div class="desc docblock-short">A set of review comments on a pull/merge request.</div></li><li><div class="item-name"><a class="mod" href="topic/index.html" title="mod f3_rs::topic">topic</a></div><div class="desc docblock-short">A list of categories associated with a project.</div></li><li><div class="item-name"><a class="mod" href="user/index.html" title="mod f3_rs::user">user</a></div><div class="desc docblock-short">A forge user</div></li></ul><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.OpenCloseState.html" title="enum f3_rs::OpenCloseState">OpenCloseState</a></div><div class="desc docblock-short">states of issue, milestone, etc with only “open” and “closed” states and “closed” states and
“closed” states and “closed” states</div></li></ul></section></div></main></body></html>