Skip to content

Commit

Permalink
Deploying to gh-pages from @ 577acac 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@equation314
equation314 committed Dec 17, 2024
0 parents commit 69c171b
Show file tree
Hide file tree
Showing 47 changed files with 1,756 additions and 0 deletions.
Empty file added .lock
Empty file.
2 changes: 2 additions & 0 deletions crates.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
window.ALL_CRATES = ["flatten_objects"];
//{"start":21,"fragment_lengths":[17]}
1 change: 1 addition & 0 deletions flatten_objects/all.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<!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="List of all items in this crate"><title>List of all items in this crate</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-46132b98.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="flatten_objects" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.0-nightly (6d9f6ae36 2024-12-16)" data-channel="nightly" data-search-js="search-036cda7a.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc mod sys"><!--[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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../flatten_objects/index.html">flatten_<wbr>objects</a><span class="version">0.2.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h3><a href="#structs">Crate Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><h1>List of all items</h1><h3 id="structs">Structs</h3><ul class="all-items"><li><a href="struct.FlattenObjects.html">FlattenObjects</a></li></ul></section></div></main></body></html>
26 changes: 26 additions & 0 deletions flatten_objects/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<!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="`FlattenObjects` is a container that stores numbered objects."><title>flatten_objects - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-46132b98.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="flatten_objects" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.0-nightly (6d9f6ae36 2024-12-16)" data-channel="nightly" data-search-js="search-036cda7a.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../flatten_objects/index.html">flatten_<wbr>objects</a><span class="version">0.2.1</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#example" title="Example">Example</a></li></ul><h3><a href="#structs">Crate Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>flatten_objects</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/flatten_objects/lib.rs.html#1-323">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><a href="struct.FlattenObjects.html" title="struct flatten_objects::FlattenObjects"><code>FlattenObjects</code></a> is a container that stores numbered objects.</p>
<p>Objects can be added to the <a href="struct.FlattenObjects.html" title="struct flatten_objects::FlattenObjects"><code>FlattenObjects</code></a>, a unique ID will be assigned
to the object. The ID can be used to retrieve the object later.</p>
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>flatten_objects::FlattenObjects;

<span class="kw">let </span><span class="kw-2">mut </span>objects = FlattenObjects::&lt;u32, <span class="number">20</span>&gt;::new();

<span class="comment">// Add `23` 10 times and assign them IDs from 0 to 9.
</span><span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..=<span class="number">9 </span>{
objects.add_at(i, <span class="number">23</span>).unwrap();
<span class="macro">assert!</span>(objects.is_assigned(i));
}

<span class="comment">// Remove the object with ID 6.
</span><span class="macro">assert_eq!</span>(objects.remove(<span class="number">6</span>), <span class="prelude-val">Some</span>(<span class="number">23</span>));
<span class="macro">assert!</span>(!objects.is_assigned(<span class="number">6</span>));

<span class="comment">// Add `42` (the ID 6 is available now).
</span><span class="kw">let </span>id = objects.add(<span class="number">42</span>).unwrap();
<span class="macro">assert_eq!</span>(id, <span class="number">6</span>);
<span class="macro">assert!</span>(objects.is_assigned(id));
<span class="macro">assert_eq!</span>(objects.get(id), <span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span><span class="number">42</span>));
<span class="macro">assert_eq!</span>(objects.remove(id), <span class="prelude-val">Some</span>(<span class="number">42</span>));
<span class="macro">assert!</span>(!objects.is_assigned(id));</code></pre></div>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.FlattenObjects.html" title="struct flatten_objects::FlattenObjects">Flatten<wbr>Objects</a></div><div class="desc docblock-short">A container that stores numbered objects.</div></li></ul></section></div></main></body></html>
1 change: 1 addition & 0 deletions flatten_objects/sidebar-items.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"struct":["FlattenObjects"]};
Loading

0 comments on commit 69c171b

Please sign in to comment.