17 lines
9.4 KiB
HTML
17 lines
9.4 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="Iterator adaptors for iterators of `Element`."><title>ElementIterator in petgraph::data - 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-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="petgraph" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.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 trait"><!--[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="../../petgraph/index.html">petgraph</a><span class="version">0.6.5</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Element<wbr>Iterator</a></h2><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.filter_elements" title="filter_elements">filter_elements</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In petgraph::<wbr>data</a></h2></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"><span class="rustdoc-breadcrumbs"><a href="../index.html">petgraph</a>::<wbr><a href="index.html">data</a></span><h1>Trait <span class="trait">ElementIterator</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/petgraph/data.rs.html#370-392">Source</a> </span></div><pre class="rust item-decl"><code>pub trait ElementIterator<N, E>: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = <a class="enum" href="enum.Element.html" title="enum petgraph::data::Element">Element</a><N, E>> {
|
|
// Provided method
|
|
fn <a href="#method.filter_elements" class="fn">filter_elements</a><F>(self, f: F) -> <a class="struct" href="struct.FilterElements.html" title="struct petgraph::data::FilterElements">FilterElements</a><Self, F> <a href="#" class="tooltip" data-notable-ty="FilterElements<Self, F>">ⓘ</a>
|
|
<span class="where">where Self: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="enum" href="enum.Element.html" title="enum petgraph::data::Element">Element</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut N</a>, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut E</a>>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a></span> { ... }
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Iterator adaptors for iterators of <code>Element</code>.</p>
|
|
</div></details><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.filter_elements" class="method"><a class="src rightside" href="../../src/petgraph/data.rs.html#380-391">Source</a><h4 class="code-header">fn <a href="#method.filter_elements" class="fn">filter_elements</a><F>(self, f: F) -> <a class="struct" href="struct.FilterElements.html" title="struct petgraph::data::FilterElements">FilterElements</a><Self, F> <a href="#" class="tooltip" data-notable-ty="FilterElements<Self, F>">ⓘ</a><div class="where">where
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="enum" href="enum.Element.html" title="enum petgraph::data::Element">Element</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut N</a>, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut E</a>>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a>,</div></h4></section></summary><div class="docblock"><p>Create an iterator adaptor that filters graph elements.</p>
|
|
<p>The function <code>f</code> is called with each element and if its return value
|
|
is <code>true</code> the element is accepted and if <code>false</code> it is removed.
|
|
<code>f</code> is called with mutable references to the node and edge weights,
|
|
so that they can be mutated (but the edge endpoints can not).</p>
|
|
<p>This filter adapts the edge source and target indices in the
|
|
stream so that they are correct after the removals.</p>
|
|
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-ElementIterator%3CN,+E%3E-for-I" class="impl"><a class="src rightside" href="../../src/petgraph/data.rs.html#394">Source</a><a href="#impl-ElementIterator%3CN,+E%3E-for-I" class="anchor">§</a><h3 class="code-header">impl<N, E, I> <a class="trait" href="trait.ElementIterator.html" title="trait petgraph::data::ElementIterator">ElementIterator</a><N, E> for I<div class="where">where
|
|
I: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = <a class="enum" href="enum.Element.html" title="enum petgraph::data::Element">Element</a><N, E>> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></div><script src="../../trait.impl/petgraph/data/trait.ElementIterator.js" async></script><script type="text/json" id="notable-traits-data">{"FilterElements<Self, F>":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.FilterElements.html\" title=\"struct petgraph::data::FilterElements\">FilterElements</a><I, F></code></h3><pre><code><div class=\"where\">impl<I, F, N, E> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.84.0/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"struct.FilterElements.html\" title=\"struct petgraph::data::FilterElements\">FilterElements</a><I, F><div class=\"where\">where\n I: <a class=\"trait\" href=\"https://doc.rust-lang.org/1.84.0/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a><Item = <a class=\"enum\" href=\"enum.Element.html\" title=\"enum petgraph::data::Element\">Element</a><N, E>>,\n F: <a class=\"trait\" href=\"https://doc.rust-lang.org/1.84.0/core/ops/function/trait.FnMut.html\" title=\"trait core::ops::function::FnMut\">FnMut</a>(<a class=\"enum\" href=\"enum.Element.html\" title=\"enum petgraph::data::Element\">Element</a><<a class=\"primitive\" href=\"https://doc.rust-lang.org/1.84.0/std/primitive.reference.html\">&mut N</a>, <a class=\"primitive\" href=\"https://doc.rust-lang.org/1.84.0/std/primitive.reference.html\">&mut E</a>>) -> <a class=\"primitive\" href=\"https://doc.rust-lang.org/1.84.0/std/primitive.bool.html\">bool</a>,</div></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.84.0/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = <a class=\"enum\" href=\"enum.Element.html\" title=\"enum petgraph::data::Element\">Element</a><N, E>;</div>"}</script></section></div></main></body></html> |