203 lines
23 KiB
HTML
203 lines
23 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 `Dfs` struct in crate `petgraph`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, Dfs">
|
|||
|
|
|
|||
|
|
<title>petgraph::visit::Dfs - 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="../../dark.css">
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../../main.css" id="themeStyle">
|
|||
|
|
<script src="../../storage.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
<body class="rustdoc struct">
|
|||
|
|
<!--[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>
|
|||
|
|
|
|||
|
|
<p class='location'>Struct Dfs</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#fields">Fields</a><div class="sidebar-links"><a href="#structfield.stack">stack</a><a href="#structfield.discovered">discovered</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.from_parts">from_parts</a><a href="#method.reset">reset</a><a href="#method.empty">empty</a><a href="#method.move_to">move_to</a><a href="#method.next">next</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-Walker%3CG%3E">Walker<G></a></div></div><p class='location'><a href='../index.html'>petgraph</a>::<wbr><a href='index.html'>visit</a></p><script>window.sidebarCurrent = {name: 'Dfs', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<div class="theme-picker">
|
|||
|
|
<button id="theme-picker" aria-label="Pick another theme!">
|
|||
|
|
<img src="../../brush.svg" width="18" alt="Pick another theme!">
|
|||
|
|
</button>
|
|||
|
|
<div id="theme-choices"></div>
|
|||
|
|
</div>
|
|||
|
|
<script src="../../theme.js"></script>
|
|||
|
|
<nav class="sub">
|
|||
|
|
<form class="search-form js-only">
|
|||
|
|
<div class="search-container">
|
|||
|
|
<input class="search-input" name="search"
|
|||
|
|
autocomplete="off"
|
|||
|
|
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
|||
|
|
type="search">
|
|||
|
|
</div>
|
|||
|
|
</form>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section id='main' class="content">
|
|||
|
|
<h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>petgraph</a>::<wbr><a href='index.html'>visit</a>::<wbr><a class="struct" href=''>Dfs</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/petgraph/visit/traversal.rs.html#38-43' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust struct'>pub struct Dfs<N, VM> {
|
|||
|
|
pub stack: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><N>,
|
|||
|
|
pub discovered: VM,
|
|||
|
|
}</pre><div class='docblock'><p>Visit nodes of a graph in a depth-first-search (DFS) emitting nodes in
|
|||
|
|
preorder (when they are first discovered).</p>
|
|||
|
|
<p>The traversal starts at a given node and only traverses nodes reachable
|
|||
|
|
from it.</p>
|
|||
|
|
<p><code>Dfs</code> is not recursive.</p>
|
|||
|
|
<p><code>Dfs</code> does not itself borrow the graph, and because of this you can run
|
|||
|
|
a traversal over a graph while still retaining mutable access to it, if you
|
|||
|
|
use it like the following example:</p>
|
|||
|
|
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">petgraph</span>::<span class="ident">Graph</span>;
|
|||
|
|
<span class="kw">use</span> <span class="ident">petgraph</span>::<span class="ident">visit</span>::<span class="ident">Dfs</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">graph</span> <span class="op">=</span> <span class="ident">Graph</span>::<span class="op"><</span>_,()<span class="op">></span>::<span class="ident">new</span>();
|
|||
|
|
<span class="kw">let</span> <span class="ident">a</span> <span class="op">=</span> <span class="ident">graph</span>.<span class="ident">add_node</span>(<span class="number">0</span>);
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">dfs</span> <span class="op">=</span> <span class="ident">Dfs</span>::<span class="ident">new</span>(<span class="kw-2">&</span><span class="ident">graph</span>, <span class="ident">a</span>);
|
|||
|
|
<span class="kw">while</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">nx</span>) <span class="op">=</span> <span class="ident">dfs</span>.<span class="ident">next</span>(<span class="kw-2">&</span><span class="ident">graph</span>) {
|
|||
|
|
<span class="comment">// we can access `graph` mutably here still</span>
|
|||
|
|
<span class="ident">graph</span>[<span class="ident">nx</span>] <span class="op">+=</span> <span class="number">1</span>;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">graph</span>[<span class="ident">a</span>], <span class="number">1</span>);</pre>
|
|||
|
|
<p><strong>Note:</strong> The algorithm may not behave correctly if nodes are removed
|
|||
|
|
during iteration. It may not necessarily visit added nodes or edges.</p>
|
|||
|
|
</div><h2 id='fields' class='fields small-section-header'>
|
|||
|
|
Fields<a href='#fields' class='anchor'></a></h2><span id="structfield.stack" class="structfield small-section-header">
|
|||
|
|
<a href="#structfield.stack" class="anchor field"></a>
|
|||
|
|
<span id="stack.v" class='invisible'>
|
|||
|
|
<code>stack: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><N></code>
|
|||
|
|
</span></span><div class='docblock'><p>The stack of nodes to visit</p>
|
|||
|
|
</div><span id="structfield.discovered" class="structfield small-section-header">
|
|||
|
|
<a href="#structfield.discovered" class="anchor field"></a>
|
|||
|
|
<span id="discovered.v" class='invisible'>
|
|||
|
|
<code>discovered: VM</code>
|
|||
|
|
</span></span><div class='docblock'><p>The map of discovered nodes</p>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='methods' class='small-section-header'>
|
|||
|
|
Methods<a href='#methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl' class='impl'><span class='in-band'><code>impl<N, VM> <a class="struct" href="../../petgraph/visit/struct.Dfs.html" title="struct petgraph::visit::Dfs">Dfs</a><N, VM> <span class="where fmt-newline">where<br> N: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>,<br> VM: <a class="trait" href="../../petgraph/visit/trait.VisitMap.html" title="trait petgraph::visit::VisitMap">VisitMap</a><N>, </span></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/petgraph/visit/traversal.rs.html#45-109' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a><G>(graph: G, start: N) -> Self <span class="where fmt-newline">where<br> G: <a class="trait" href="../../petgraph/visit/trait.GraphRef.html" title="trait petgraph::visit::GraphRef">GraphRef</a> + <a class="trait" href="../../petgraph/visit/trait.Visitable.html" title="trait petgraph::visit::Visitable">Visitable</a><NodeId = N, Map = VM>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/petgraph/visit/traversal.rs.html#51-57' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Create a new <strong>Dfs</strong>, using the graph's visitor map, and put <strong>start</strong>
|
|||
|
|
in the stack of nodes to visit.</p>
|
|||
|
|
</div><h4 id='method.from_parts' class="method"><span id='from_parts.v' class='invisible'><code>pub fn <a href='#method.from_parts' class='fnname'>from_parts</a>(stack: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><N>, discovered: VM) -> Self</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/petgraph/visit/traversal.rs.html#60-65' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Create a <code>Dfs</code> from a vector and a visit map</p>
|
|||
|
|
</div><h4 id='method.reset' class="method"><span id='reset.v' class='invisible'><code>pub fn <a href='#method.reset' class='fnname'>reset</a><G>(&mut self, graph: G) <span class="where fmt-newline">where<br> G: <a class="trait" href="../../petgraph/visit/trait.GraphRef.html" title="trait petgraph::visit::GraphRef">GraphRef</a> + <a class="trait" href="../../petgraph/visit/trait.Visitable.html" title="trait petgraph::visit::Visitable">Visitable</a><NodeId = N, Map = VM>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/petgraph/visit/traversal.rs.html#68-73' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Clear the visit state</p>
|
|||
|
|
</div><h4 id='method.empty' class="method"><span id='empty.v' class='invisible'><code>pub fn <a href='#method.empty' class='fnname'>empty</a><G>(graph: G) -> Self <span class="where fmt-newline">where<br> G: <a class="trait" href="../../petgraph/visit/trait.GraphRef.html" title="trait petgraph::visit::GraphRef">GraphRef</a> + <a class="trait" href="../../petgraph/visit/trait.Visitable.html" title="trait petgraph::visit::Visitable">Visitable</a><NodeId = N, Map = VM>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/petgraph/visit/traversal.rs.html#76-83' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Create a new <strong>Dfs</strong> using the graph's visitor map, and no stack.</p>
|
|||
|
|
</div><h4 id='method.move_to' class="method"><span id='move_to.v' class='invisible'><code>pub fn <a href='#method.move_to' class='fnname'>move_to</a>(&mut self, start: N)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/petgraph/visit/traversal.rs.html#87-92' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Keep the discovered map, but clear the visit stack and restart
|
|||
|
|
the dfs from a particular node.</p>
|
|||
|
|
</div><h4 id='method.next' class="method"><span id='next.v' class='invisible'><code>pub fn <a href='#method.next' class='fnname'>next</a><G>(&mut self, graph: G) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><N> <span class="where fmt-newline">where<br> G: <a class="trait" href="../../petgraph/visit/trait.IntoNeighbors.html" title="trait petgraph::visit::IntoNeighbors">IntoNeighbors</a><NodeId = N>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/petgraph/visit/traversal.rs.html#95-108' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Return the next node in the dfs, or <strong>None</strong> if the traversal is done.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='implementations' class='small-section-header'>
|
|||
|
|
Trait Implementations<a href='#implementations' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl<N: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, VM: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../petgraph/visit/struct.Dfs.html" title="struct petgraph::visit::Dfs">Dfs</a><N, VM></code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/petgraph/visit/traversal.rs.html#37' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../../petgraph/visit/struct.Dfs.html" title="struct petgraph::visit::Dfs">Dfs</a><N, VM></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/petgraph/visit/traversal.rs.html#37' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
|||
|
|
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#112-114' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
|||
|
|
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl<N: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>, VM: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../petgraph/visit/struct.Dfs.html" title="struct petgraph::visit::Dfs">Dfs</a><N, VM></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/petgraph/visit/traversal.rs.html#37' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, __arg_0: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/petgraph/visit/traversal.rs.html#37' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
|||
|
|
</div></div><h3 id='impl-Walker%3CG%3E' class='impl'><span class='in-band'><code>impl<G> <a class="trait" href="../../petgraph/visit/trait.Walker.html" title="trait petgraph::visit::Walker">Walker</a><G> for <a class="struct" href="../../petgraph/visit/struct.Dfs.html" title="struct petgraph::visit::Dfs">Dfs</a><G::<a class="type" href="../../petgraph/visit/trait.GraphBase.html#associatedtype.NodeId" title="type petgraph::visit::GraphBase::NodeId">NodeId</a>, G::<a class="type" href="../../petgraph/visit/trait.Visitable.html#associatedtype.Map" title="type petgraph::visit::Visitable::Map">Map</a>> <span class="where fmt-newline">where<br> G: <a class="trait" href="../../petgraph/visit/trait.IntoNeighbors.html" title="trait petgraph::visit::IntoNeighbors">IntoNeighbors</a> + <a class="trait" href="../../petgraph/visit/trait.Visitable.html" title="trait petgraph::visit::Visitable">Visitable</a>, </span></code><a href='#impl-Walker%3CG%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/petgraph/visit/traversal.rs.html#406-413' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='associatedtype.Item' class="type"><span id='Item.t' class='invisible'><code>type <a href='../../petgraph/visit/trait.Walker.html#associatedtype.Item' class="type">Item</a> = G::<a class="type" href="../../petgraph/visit/trait.GraphBase.html#associatedtype.NodeId" title="type petgraph::visit::GraphBase::NodeId">NodeId</a></code></span></h4>
|
|||
|
|
<h4 id='method.walk_next' class="method"><span id='walk_next.v' class='invisible'><code>fn <a href='../../petgraph/visit/trait.Walker.html#tymethod.walk_next' class='fnname'>walk_next</a>(&mut self, context: G) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self::<a class="type" href="../../petgraph/visit/trait.Walker.html#associatedtype.Item" title="type petgraph::visit::Walker::Item">Item</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/petgraph/visit/traversal.rs.html#410-412' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Advance to the next item</p>
|
|||
|
|
</div><h4 id='method.iter' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../../petgraph/visit/struct.WalkerIter.html" title="struct petgraph::visit::WalkerIter">WalkerIter</a><W, C></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../../petgraph/visit/struct.WalkerIter.html" title="struct petgraph::visit::WalkerIter">WalkerIter</a><W, C></h3><code class="content"><span class="where fmt-newline">impl<W, C> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="../../petgraph/visit/struct.WalkerIter.html" title="struct petgraph::visit::WalkerIter">WalkerIter</a><W, C> <span class="where fmt-newline">where<br> W: <a class="trait" href="../../petgraph/visit/trait.Walker.html" title="trait petgraph::visit::Walker">Walker</a><C>,<br> C: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = W::<a class="type" href="../../petgraph/visit/trait.Walker.html#associatedtype.Item" title="type petgraph::visit::Walker::Item">Item</a>;</span></code></div></div><span id='iter.v' class='invisible'><code>fn <a href='../../petgraph/visit/trait.Walker.html#method.iter' class='fnname'>iter</a>(self, context: Context) -> <a class="struct" href="../../petgraph/visit/struct.WalkerIter.html" title="struct petgraph::visit::WalkerIter">WalkerIter</a><Self, Context> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,<br> Context: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/petgraph/visit/traversal.rs.html#361-369' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Create an iterator out of the walker and given <code>context</code>.</p>
|
|||
|
|
</div></div></section>
|
|||
|
|
<section id='search' class="content hidden"></section>
|
|||
|
|
|
|||
|
|
<section class="footer"></section>
|
|||
|
|
|
|||
|
|
<aside id="help" class="hidden">
|
|||
|
|
<div>
|
|||
|
|
<h1 class="hidden">Help</h1>
|
|||
|
|
|
|||
|
|
<div class="shortcuts">
|
|||
|
|
<h2>Keyboard Shortcuts</h2>
|
|||
|
|
|
|||
|
|
<dl>
|
|||
|
|
<dt><kbd>?</kbd></dt>
|
|||
|
|
<dd>Show this help dialog</dd>
|
|||
|
|
<dt><kbd>S</kbd></dt>
|
|||
|
|
<dd>Focus the search field</dd>
|
|||
|
|
<dt><kbd>↑</kbd></dt>
|
|||
|
|
<dd>Move up in search results</dd>
|
|||
|
|
<dt><kbd>↓</kbd></dt>
|
|||
|
|
<dd>Move down in search results</dd>
|
|||
|
|
<dt><kbd>↹</kbd></dt>
|
|||
|
|
<dd>Switch tab</dd>
|
|||
|
|
<dt><kbd>⏎</kbd></dt>
|
|||
|
|
<dd>Go to active search result</dd>
|
|||
|
|
<dt><kbd>+</kbd></dt>
|
|||
|
|
<dd>Expand all sections</dd>
|
|||
|
|
<dt><kbd>-</kbd></dt>
|
|||
|
|
<dd>Collapse all sections</dd>
|
|||
|
|
</dl>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="infos">
|
|||
|
|
<h2>Search Tricks</h2>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Prefix searches with a type followed by a colon (e.g.
|
|||
|
|
<code>fn:</code>) to restrict the search to a given type.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Accepted types are: <code>fn</code>, <code>mod</code>,
|
|||
|
|
<code>struct</code>, <code>enum</code>,
|
|||
|
|
<code>trait</code>, <code>type</code>, <code>macro</code>,
|
|||
|
|
and <code>const</code>.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Search functions by type signature (e.g.
|
|||
|
|
<code>vec -> usize</code> or <code>* -> vec</code>)
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</aside>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
window.rootPath = "../../";
|
|||
|
|
window.currentCrate = "petgraph";
|
|||
|
|
</script>
|
|||
|
|
<script src="../../main.js"></script>
|
|||
|
|
<script defer src="../../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|