mentat/petgraph/prelude/index.html

132 lines
8.2 KiB
HTML
Raw Normal View History

2018-08-22 17:04:13 +00:00
<!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 `prelude` mod in crate `petgraph`.">
<meta name="keywords" content="rust, rustlang, rust-lang, prelude">
<title>petgraph::prelude - 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 mod">
<!--[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">&#9776;</div>
<p class='location'>Module prelude</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li></ul></div><p class='location'><a href='../index.html'>petgraph</a></p><script>window.sidebarCurrent = {name: 'prelude', ty: 'mod', 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'>Module <a href='../index.html'>petgraph</a>::<wbr><a class="mod" href=''>prelude</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'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../../src/petgraph/prelude.rs.html#2-48' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>Commonly used items.</p>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">petgraph</span>::<span class="ident">prelude</span>::<span class="kw-2">*</span>;</pre>
</div><h2 id='reexports' class='section-header'><a href="#reexports">Re-exports</a></h2>
<table><tr><td><code>pub use graph::<a class="struct" href="../../petgraph/graph/struct.Graph.html" title="struct petgraph::graph::Graph">Graph</a>;</code></td></tr><tr><td><code>pub use graph::<a class="struct" href="../../petgraph/graph/struct.NodeIndex.html" title="struct petgraph::graph::NodeIndex">NodeIndex</a>;</code></td></tr><tr><td><code>pub use graph::<a class="struct" href="../../petgraph/graph/struct.EdgeIndex.html" title="struct petgraph::graph::EdgeIndex">EdgeIndex</a>;</code></td></tr><tr><td><code>pub use graph::<a class="type" href="../../petgraph/graph/type.DiGraph.html" title="type petgraph::graph::DiGraph">DiGraph</a>;</code></td></tr><tr><td><code>pub use graph::<a class="type" href="../../petgraph/graph/type.UnGraph.html" title="type petgraph::graph::UnGraph">UnGraph</a>;</code></td></tr><tr><td><code>pub use graphmap::<a class="struct" href="../../petgraph/graphmap/struct.GraphMap.html" title="struct petgraph::graphmap::GraphMap">GraphMap</a>;</code></td></tr><tr><td><code>pub use graphmap::<a class="type" href="../../petgraph/graphmap/type.DiGraphMap.html" title="type petgraph::graphmap::DiGraphMap">DiGraphMap</a>;</code></td></tr><tr><td><code>pub use graphmap::<a class="type" href="../../petgraph/graphmap/type.UnGraphMap.html" title="type petgraph::graphmap::UnGraphMap">UnGraphMap</a>;</code></td></tr><tr><td><code>pub use stable_graph::<a class="struct" href="../../petgraph/stable_graph/struct.StableGraph.html" title="struct petgraph::stable_graph::StableGraph">StableGraph</a>;</code></td></tr><tr><td><code>pub use stable_graph::<a class="type" href="../../petgraph/stable_graph/type.StableDiGraph.html" title="type petgraph::stable_graph::StableDiGraph">StableDiGraph</a>;</code></td></tr><tr><td><code>pub use stable_graph::<a class="type" href="../../petgraph/stable_graph/type.StableUnGraph.html" title="type petgraph::stable_graph::StableUnGraph">StableUnGraph</a>;</code></td></tr><tr><td><code>pub use visit::<a class="struct" href="../../petgraph/visit/struct.Bfs.html" title="struct petgraph::visit::Bfs">Bfs</a>;</code></td></tr><tr><td><code>pub use visit::<a class="struct" href="../../petgraph/visit/struct.Dfs.html" title="struct petgraph::visit::Dfs">Dfs</a>;</code></td></tr><tr><td><code>pub use visit::<a class="struct" href="../../petgraph/visit/struct.DfsPostOrder.html" title="struct petgraph::visit::DfsPostOrder">DfsPostOrder</a>;</code></td></tr><tr><td><code>pub use <a class="enum" href="../../petgraph/enum.Direction.html" title="enum petgraph::Direction">Direction</a>;</code></td></tr><tr><td><code>pub use <a class="enum" href="../../petgraph/enum.Direction.html" title="enum petgraph::Direction">Incoming</a>;</code></td></tr><tr><td><code>pub use <a class="enum" href="../../petgraph/enum.Direction.html" title="enum petgraph::Direction">Outgoing</a>;</code></td></tr><tr><td><code>pub use <a class="enum" href="../../petgraph/enum.Directed.html" title="enum petgraph::Directed">Directed</a>;</code></td></tr><tr><td><code>pub use <a class="enum" href="../../petgraph/enum.Undirected.html" title="enum petgraph::Undirected">Undirected</a>;</code></td></tr><tr><td><code>pub use visit::<a class="trait" href="../../petgraph/visit/trait.EdgeRef.html" title="trait petgraph::visit::EdgeRef">EdgeRef</a>;</code></td></tr></table></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>&#9166;</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>