165 lines
15 KiB
HTML
165 lines
15 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 `Walker` trait in crate `petgraph`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, Walker">
|
|||
|
|
|
|||
|
|
<title>petgraph::visit::Walker - 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 trait">
|
|||
|
|
<!--[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'>Trait Walker</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Item">Item</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.walk_next">walk_next</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.iter">iter</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>petgraph</a>::<wbr><a href='index.html'>visit</a></p><script>window.sidebarCurrent = {name: 'Walker', ty: 'trait', 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'>Trait <a href='../index.html'>petgraph</a>::<wbr><a href='index.html'>visit</a>::<wbr><a class="trait" href=''>Walker</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#355-370' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust trait'>pub trait Walker<Context> {
|
|||
|
|
type <a href='#associatedtype.Item' class="type">Item</a>;
|
|||
|
|
fn <a href='#tymethod.walk_next' class='fnname'>walk_next</a>(&mut self, context: Context) -> <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>>;
|
|||
|
|
|
|||
|
|
fn <a href='#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><br> <span class="where">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>,
|
|||
|
|
{ ... }
|
|||
|
|
}</pre><div class='docblock'><p>A walker is a traversal state, but where part of the traversal
|
|||
|
|
information is supplied manually to each next call.</p>
|
|||
|
|
<p>This for example allows graph traversals that don't hold a borrow of the
|
|||
|
|
graph they are traversing.</p>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='associated-types' class='small-section-header'>
|
|||
|
|
Associated Types<a href='#associated-types' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div class='methods'>
|
|||
|
|
<h3 id='associatedtype.Item' class='method'><span id='Item.t' class='invisible'><code>type <a href='#associatedtype.Item' class="type">Item</a></code></span></h3></div>
|
|||
|
|
<h2 id='required-methods' class='small-section-header'>
|
|||
|
|
Required Methods<a href='#required-methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div class='methods'>
|
|||
|
|
<h3 id='tymethod.walk_next' class='method'><span id='walk_next.v' class='invisible'><code>fn <a href='#tymethod.walk_next' class='fnname'>walk_next</a>(&mut self, context: Context) -> <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></h3><div class='docblock'><p>Advance to the next item</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='provided-methods' class='small-section-header'>
|
|||
|
|
Provided Methods<a href='#provided-methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div class='methods'>
|
|||
|
|
<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><h3 id='method.iter' class='method'><span id='iter.v' class='invisible'><code>fn <a href='#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></h3><div class='docblock'><p>Create an iterator out of the walker and given <code>context</code>.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='implementors' class='small-section-header'>
|
|||
|
|
Implementors<a href='#implementors' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<ul class='item-list' id='implementors-list'>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../../src/petgraph/visit/traversal.rs.html#406-413' title='goto source code'>[src]</a></div><code>impl<G> Walker<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><span class="where fmt-newline"> type <a href='#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>;</span></code></li>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../../src/petgraph/visit/traversal.rs.html#415-422' title='goto source code'>[src]</a></div><code>impl<G> Walker<G> for <a class="struct" href="../../petgraph/visit/struct.DfsPostOrder.html" title="struct petgraph::visit::DfsPostOrder">DfsPostOrder</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><span class="where fmt-newline"> type <a href='#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>;</span></code></li>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../../src/petgraph/visit/traversal.rs.html#424-431' title='goto source code'>[src]</a></div><code>impl<G> Walker<G> for <a class="struct" href="../../petgraph/visit/struct.Bfs.html" title="struct petgraph::visit::Bfs">Bfs</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><span class="where fmt-newline"> type <a href='#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>;</span></code></li>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../../src/petgraph/visit/traversal.rs.html#433-440' title='goto source code'>[src]</a></div><code>impl<G> Walker<G> for <a class="struct" href="../../petgraph/visit/struct.Topo.html" title="struct petgraph::visit::Topo">Topo</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.IntoNeighborsDirected.html" title="trait petgraph::visit::IntoNeighborsDirected">IntoNeighborsDirected</a> + <a class="trait" href="../../petgraph/visit/trait.Visitable.html" title="trait petgraph::visit::Visitable">Visitable</a>, </span><span class="where fmt-newline"> type <a href='#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>;</span></code></li>
|
|||
|
|
</ul><script type="text/javascript" async
|
|||
|
|
src="../../implementors/petgraph/visit/trait.Walker.js">
|
|||
|
|
</script></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>
|