174 lines
18 KiB
HTML
174 lines
18 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 `EdgeRef` trait in crate `petgraph`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, EdgeRef">
|
|||
|
|
|
|||
|
|
<title>petgraph::visit::EdgeRef - 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 EdgeRef</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.NodeId">NodeId</a><a href="#associatedtype.EdgeId">EdgeId</a><a href="#associatedtype.Weight">Weight</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.source">source</a><a href="#tymethod.target">target</a><a href="#tymethod.weight">weight</a><a href="#tymethod.id">id</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-EdgeRef">(N, N, &'a E)</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: 'EdgeRef', 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=''>EdgeRef</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/mod.rs.html#337-349' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust trait'>pub trait EdgeRef: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> {
|
|||
|
|
type <a href='#associatedtype.NodeId' class="type">NodeId</a>;
|
|||
|
|
type <a href='#associatedtype.EdgeId' class="type">EdgeId</a>;
|
|||
|
|
type <a href='#associatedtype.Weight' class="type">Weight</a>;
|
|||
|
|
fn <a href='#tymethod.source' class='fnname'>source</a>(&self) -> Self::<a class="type" href="../../petgraph/visit/trait.EdgeRef.html#associatedtype.NodeId" title="type petgraph::visit::EdgeRef::NodeId">NodeId</a>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.target' class='fnname'>target</a>(&self) -> Self::<a class="type" href="../../petgraph/visit/trait.EdgeRef.html#associatedtype.NodeId" title="type petgraph::visit::EdgeRef::NodeId">NodeId</a>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.weight' class='fnname'>weight</a>(&self) -> &Self::<a class="type" href="../../petgraph/visit/trait.EdgeRef.html#associatedtype.Weight" title="type petgraph::visit::EdgeRef::Weight">Weight</a>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.id' class='fnname'>id</a>(&self) -> Self::<a class="type" href="../../petgraph/visit/trait.EdgeRef.html#associatedtype.EdgeId" title="type petgraph::visit::EdgeRef::EdgeId">EdgeId</a>;
|
|||
|
|
}</pre><div class='docblock'><p>An edge reference.</p>
|
|||
|
|
<p>Edge references are used by traits <code>IntoEdges</code> and <code>IntoEdgeReferences</code>.</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.NodeId' class='method'><span id='NodeId.t' class='invisible'><code>type <a href='#associatedtype.NodeId' class="type">NodeId</a></code></span></h3><h3 id='associatedtype.EdgeId' class='method'><span id='EdgeId.t' class='invisible'><code>type <a href='#associatedtype.EdgeId' class="type">EdgeId</a></code></span></h3><h3 id='associatedtype.Weight' class='method'><span id='Weight.t' class='invisible'><code>type <a href='#associatedtype.Weight' class="type">Weight</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.source' class='method'><span id='source.v' class='invisible'><code>fn <a href='#tymethod.source' class='fnname'>source</a>(&self) -> Self::<a class="type" href="../../petgraph/visit/trait.EdgeRef.html#associatedtype.NodeId" title="type petgraph::visit::EdgeRef::NodeId">NodeId</a></code></span></h3><div class='docblock'><p>The source node of the edge.</p>
|
|||
|
|
</div><h3 id='tymethod.target' class='method'><span id='target.v' class='invisible'><code>fn <a href='#tymethod.target' class='fnname'>target</a>(&self) -> Self::<a class="type" href="../../petgraph/visit/trait.EdgeRef.html#associatedtype.NodeId" title="type petgraph::visit::EdgeRef::NodeId">NodeId</a></code></span></h3><div class='docblock'><p>The target node of the edge.</p>
|
|||
|
|
</div><h3 id='tymethod.weight' class='method'><span id='weight.v' class='invisible'><code>fn <a href='#tymethod.weight' class='fnname'>weight</a>(&self) -> &Self::<a class="type" href="../../petgraph/visit/trait.EdgeRef.html#associatedtype.Weight" title="type petgraph::visit::EdgeRef::Weight">Weight</a></code></span></h3><div class='docblock'><p>A reference to the weight of the edge.</p>
|
|||
|
|
</div><h3 id='tymethod.id' class='method'><span id='id.v' class='invisible'><code>fn <a href='#tymethod.id' class='fnname'>id</a>(&self) -> Self::<a class="type" href="../../petgraph/visit/trait.EdgeRef.html#associatedtype.EdgeId" title="type petgraph::visit::EdgeRef::EdgeId">EdgeId</a></code></span></h3><div class='docblock'><p>The edge’s identifier.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='foreign-impls' class='small-section-header'>
|
|||
|
|
Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl-EdgeRef' class='impl'><span class='in-band'><code>impl<'a, N, E> <a class="trait" href="../../petgraph/visit/trait.EdgeRef.html" title="trait petgraph::visit::EdgeRef">EdgeRef</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>N, N, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>E<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a> <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>, </span></code><a href='#impl-EdgeRef' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/petgraph/visit/mod.rs.html#351-362' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<span class='docblock autohide'><div class='impl-items'><h4 id='associatedtype.NodeId-1' class="type"><span id='NodeId.t-1' class='invisible'><code>type <a href='#associatedtype.NodeId' class="type">NodeId</a> = N</code></span></h4>
|
|||
|
|
<h4 id='associatedtype.EdgeId-1' class="type"><span id='EdgeId.t-1' class='invisible'><code>type <a href='#associatedtype.EdgeId' class="type">EdgeId</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>N, N<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></span></h4>
|
|||
|
|
<h4 id='associatedtype.Weight-1' class="type"><span id='Weight.t-1' class='invisible'><code>type <a href='#associatedtype.Weight' class="type">Weight</a> = E</code></span></h4>
|
|||
|
|
<h4 id='method.source' class="method"><span id='source.v-1' class='invisible'><code>fn <a href='#method.source' class='fnname'>source</a>(&self) -> N</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/petgraph/visit/mod.rs.html#358' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<h4 id='method.target' class="method"><span id='target.v-1' class='invisible'><code>fn <a href='#method.target' class='fnname'>target</a>(&self) -> N</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/petgraph/visit/mod.rs.html#359' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<h4 id='method.weight' class="method"><span id='weight.v-1' class='invisible'><code>fn <a href='#method.weight' class='fnname'>weight</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>E</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/petgraph/visit/mod.rs.html#360' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<h4 id='method.id' class="method"><span id='id.v-1' class='invisible'><code>fn <a href='#method.id' class='fnname'>id</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>N, N<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/petgraph/visit/mod.rs.html#361' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
</div></span>
|
|||
|
|
<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/reversed.rs.html#77-95' title='goto source code'>[src]</a></div><code>impl<R> EdgeRef for <a class="struct" href="../../petgraph/visit/struct.ReversedEdgeReference.html" title="struct petgraph::visit::ReversedEdgeReference">ReversedEdgeReference</a><R> <span class="where fmt-newline">where<br> R: <a class="trait" href="../../petgraph/visit/trait.EdgeRef.html" title="trait petgraph::visit::EdgeRef">EdgeRef</a>, </span><span class="where fmt-newline"> type <a href='#associatedtype.NodeId' class="type">NodeId</a> = R::<a class="type" href="../../petgraph/visit/trait.EdgeRef.html#associatedtype.NodeId" title="type petgraph::visit::EdgeRef::NodeId">NodeId</a>;</span><span class="where fmt-newline"> type <a href='#associatedtype.EdgeId' class="type">EdgeId</a> = R::<a class="type" href="../../petgraph/visit/trait.EdgeRef.html#associatedtype.EdgeId" title="type petgraph::visit::EdgeRef::EdgeId">EdgeId</a>;</span><span class="where fmt-newline"> type <a href='#associatedtype.Weight' class="type">Weight</a> = R::<a class="type" href="../../petgraph/visit/trait.EdgeRef.html#associatedtype.Weight" title="type petgraph::visit::EdgeRef::Weight">Weight</a>;</span></code></li>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../../src/petgraph/graph_impl/stable_graph/mod.rs.html#1226-1237' title='goto source code'>[src]</a></div><code>impl<'a, Ix, E> EdgeRef for petgraph::stable_graph::<a class="struct" href="../../petgraph/stable_graph/struct.EdgeReference.html" title="struct petgraph::stable_graph::EdgeReference">EdgeReference</a><'a, E, Ix> <span class="where fmt-newline">where<br> Ix: <a class="trait" href="../../petgraph/graph/trait.IndexType.html" title="trait petgraph::graph::IndexType">IndexType</a>, </span><span class="where fmt-newline"> type <a href='#associatedtype.NodeId' class="type">NodeId</a> = <a class="struct" href="../../petgraph/graph/struct.NodeIndex.html" title="struct petgraph::graph::NodeIndex">NodeIndex</a><Ix>;</span><span class="where fmt-newline"> type <a href='#associatedtype.EdgeId' class="type">EdgeId</a> = <a class="struct" href="../../petgraph/graph/struct.EdgeIndex.html" title="struct petgraph::graph::EdgeIndex">EdgeIndex</a><Ix>;</span><span class="where fmt-newline"> type <a href='#associatedtype.Weight' class="type">Weight</a> = E;</span></code></li>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../../src/petgraph/graph_impl/mod.rs.html#1962-1973' title='goto source code'>[src]</a></div><code>impl<'a, Ix, E> EdgeRef for petgraph::graph::<a class="struct" href="../../petgraph/graph/struct.EdgeReference.html" title="struct petgraph::graph::EdgeReference">EdgeReference</a><'a, E, Ix> <span class="where fmt-newline">where<br> Ix: <a class="trait" href="../../petgraph/graph/trait.IndexType.html" title="trait petgraph::graph::IndexType">IndexType</a>, </span><span class="where fmt-newline"> type <a href='#associatedtype.NodeId' class="type">NodeId</a> = <a class="struct" href="../../petgraph/graph/struct.NodeIndex.html" title="struct petgraph::graph::NodeIndex">NodeIndex</a><Ix>;</span><span class="where fmt-newline"> type <a href='#associatedtype.EdgeId' class="type">EdgeId</a> = <a class="struct" href="../../petgraph/graph/struct.EdgeIndex.html" title="struct petgraph::graph::EdgeIndex">EdgeIndex</a><Ix>;</span><span class="where fmt-newline"> type <a href='#associatedtype.Weight' class="type">Weight</a> = E;</span></code></li>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../../src/petgraph/csr.rs.html#385-397' title='goto source code'>[src]</a></div><code>impl<'a, E, Ty, Ix> EdgeRef for petgraph::csr::<a class="struct" href="../../petgraph/csr/struct.EdgeReference.html" title="struct petgraph::csr::EdgeReference">EdgeReference</a><'a, E, Ty, Ix> <span class="where fmt-newline">where<br> Ty: <a class="trait" href="../../petgraph/trait.EdgeType.html" title="trait petgraph::EdgeType">EdgeType</a>,<br> Ix: <a class="trait" href="../../petgraph/graph/trait.IndexType.html" title="trait petgraph::graph::IndexType">IndexType</a>, </span><span class="where fmt-newline"> type <a href='#associatedtype.NodeId' class="type">NodeId</a> = <a class="type" href="../../petgraph/csr/type.NodeIndex.html" title="type petgraph::csr::NodeIndex">NodeIndex</a><Ix>;</span><span class="where fmt-newline"> type <a href='#associatedtype.EdgeId' class="type">EdgeId</a> = <a class="type" href="../../petgraph/csr/type.EdgeIndex.html" title="type petgraph::csr::EdgeIndex">EdgeIndex</a>;</span><span class="where fmt-newline"> type <a href='#associatedtype.Weight' class="type">Weight</a> = E;</span></code></li>
|
|||
|
|
</ul><script type="text/javascript" async
|
|||
|
|
src="../../implementors/petgraph/visit/trait.EdgeRef.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>
|