Skip to content

Commit 73257ac

Browse files
committed
maybe docs are better this time
1 parent 3120ffc commit 73257ac

File tree

79 files changed

+9151
-2
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+9151
-2
lines changed

Diff for: doc_script.sh

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
cargo doc --no-deps
2+
rm -rf ./docs
3+
echo "<meta http-equiv=\"refresh\" content=\"0; url=build_wheel\">" > target/doc/index.html
4+
cp -r target/doc ./docs

Diff for: docs/.lock

Whitespace-only changes.

Diff for: docs/crates.js

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
window.ALL_CRATES = ["triemap"];
2+
//{"start":21,"fragment_lengths":[9]}

Diff for: docs/help.html

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
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="Documentation for Rustdoc"><title>Help</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="triemap" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.1 (4eb161250 2025-03-15)" data-channel="1.85.1" data-search-js="search-75f5ac3e.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><a class="logo-container" href="./index.html"><img class="rust-logo" src="./static.files/rust-logo-9a9549ea.svg" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="./index.html"><img class="rust-logo" src="./static.files/rust-logo-9a9549ea.svg" alt="logo"></a><h2><a href="./index.html">Rustdoc</a><span class="version">1.85.1</span></h2></div><div class="version">(4eb161250 2025-03-15)</div><h2 class="location">Help</h2><div class="sidebar-elems"></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>Rustdoc help</h1><span class="out-of-band"><a id="back" href="javascript:void(0)" onclick="history.back();">Back</a></span></div><noscript><section><p>You need to enable JavaScript to use keyboard commands or search.</p><p>For more information, browse the <a href="https://doc.rust-lang.org/rustdoc/">rustdoc handbook</a>.</p></section></noscript></section></div></main></body></html>

Diff for: docs/index.html

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
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="API documentation for the Rust `triemap` crate."><title>triemap - 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="triemap" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.1 (4eb161250 2025-03-15)" data-channel="1.85.1" data-search-js="search-75f5ac3e.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="../triemap/index.html">triemap</a><span class="version">0.1.0</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="#structs">Crate Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</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>triemap</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/triemap/lib.rs.html#1-4036">Source</a> </span></div><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.DrainIter.html" title="struct triemap::DrainIter">Drain<wbr>Iter</a></div><div class="desc docblock-short">A draining iterator over the key-value pairs of a <code>TrieMap</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.IntoIter.html" title="struct triemap::IntoIter">Into<wbr>Iter</a></div><div class="desc docblock-short">An owning iterator over the key-value pairs of a <code>TrieMap</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.IntoKeys.html" title="struct triemap::IntoKeys">Into<wbr>Keys</a></div><div class="desc docblock-short">An owning iterator over the keys of a <code>TrieMap</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.IntoValues.html" title="struct triemap::IntoValues">Into<wbr>Values</a></div><div class="desc docblock-short">An owning iterator over the values of a <code>TrieMap</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.Iter.html" title="struct triemap::Iter">Iter</a></div><div class="desc docblock-short">An iterator over the key-value pairs of a <code>TrieMap</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.IterMut.html" title="struct triemap::IterMut">IterMut</a></div><div class="desc docblock-short">A mutable iterator over the key-value pairs of a <code>TrieMap</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.Keys.html" title="struct triemap::Keys">Keys</a></div><div class="desc docblock-short">An iterator over the keys of a <code>TrieMap</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.OccupiedEntry.html" title="struct triemap::OccupiedEntry">Occupied<wbr>Entry</a></div><div class="desc docblock-short">A view into an occupied entry in a <code>TrieMap</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.PrefixIter.html" title="struct triemap::PrefixIter">Prefix<wbr>Iter</a></div><div class="desc docblock-short">An iterator over entries with keys that start with a specific prefix.</div></li><li><div class="item-name"><a class="struct" href="struct.PrefixKeys.html" title="struct triemap::PrefixKeys">Prefix<wbr>Keys</a></div><div class="desc docblock-short">Iterator for keys that start with a specific prefix.</div></li><li><div class="item-name"><a class="struct" href="struct.PrefixValues.html" title="struct triemap::PrefixValues">Prefix<wbr>Values</a></div><div class="desc docblock-short">Iterator for values that have keys starting with a specific prefix.</div></li><li><div class="item-name"><a class="struct" href="struct.TrieMap.html" title="struct triemap::TrieMap">TrieMap</a></div><div class="desc docblock-short">A <code>TrieMap</code> is a key-value data structure that uses a trie (prefix tree) for storage
2-
and retrieval of data.</div></li><li><div class="item-name"><a class="struct" href="struct.VacantEntry.html" title="struct triemap::VacantEntry">Vacant<wbr>Entry</a></div><div class="desc docblock-short">A view into a vacant entry in a <code>TrieMap</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.Values.html" title="struct triemap::Values">Values</a></div><div class="desc docblock-short">An iterator over the values of a <code>TrieMap</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ValuesMut.html" title="struct triemap::ValuesMut">Values<wbr>Mut</a></div><div class="desc docblock-short">A mutable iterator over the values of a <code>TrieMap</code>.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.Entry.html" title="enum triemap::Entry">Entry</a></div><div class="desc docblock-short">Represents an entry in a <code>TrieMap</code> which may either be vacant or occupied.</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.AsBytes.html" title="trait triemap::AsBytes">AsBytes</a></div><div class="desc docblock-short">The <code>AsBytes</code> trait allows a type to be used as a key in a <code>TrieMap</code>.</div></li></ul></section></div></main></body></html>
1+
<meta http-equiv="refresh" content="0; url=build_wheel">

Diff for: docs/search-index.js

+4
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)