| <!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="The concrete iterator types."><meta name="keywords" content="rust, rustlang, rust-lang, structs"><title>itertools::structs - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc mod"><!--[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">☰</button><a class="sidebar-logo" href="../../itertools/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../itertools/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module structs</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#types">Type Definitions</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Module <a href="../index.html">itertools</a>::<wbr><a class="mod" href="#">structs</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/itertools/lib.rs.html#87">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The concrete iterator types.</p> |
| </div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Batching.html" title="itertools::structs::Batching struct">Batching</a></div><div class="item-right docblock-short">A “meta iterator adaptor”. Its closure receives a reference to the iterator |
| and may pick off as many elements as it likes, to produce the next iterator element.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Chunk.html" title="itertools::structs::Chunk struct">Chunk</a></div><div class="item-right docblock-short">An iterator for the elements in a single chunk.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Chunks.html" title="itertools::structs::Chunks struct">Chunks</a></div><div class="item-right docblock-short">An iterator that yields the Chunk iterators.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.CircularTupleWindows.html" title="itertools::structs::CircularTupleWindows struct">CircularTupleWindows</a></div><div class="item-right docblock-short">An iterator over all windows,wrapping back to the first elements when the |
| window would otherwise exceed the length of the iterator, producing tuples |
| of a specific size.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Combinations.html" title="itertools::structs::Combinations struct">Combinations</a></div><div class="item-right docblock-short">An iterator to iterate through all the <code>k</code>-length combinations in an iterator.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.CombinationsWithReplacement.html" title="itertools::structs::CombinationsWithReplacement struct">CombinationsWithReplacement</a></div><div class="item-right docblock-short">An iterator to iterate through all the <code>n</code>-length combinations in an iterator, with replacement.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ConsTuples.html" title="itertools::structs::ConsTuples struct">ConsTuples</a></div><div class="item-right docblock-short">An iterator that maps an iterator of tuples like |
| <code>((A, B), C)</code> to an iterator of <code>(A, B, C)</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ExactlyOneError.html" title="itertools::structs::ExactlyOneError struct">ExactlyOneError</a></div><div class="item-right docblock-short">Iterator returned for the error case of <code>IterTools::exactly_one()</code> |
| This iterator yields exactly the same elements as the input iterator.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FilterMapOk.html" title="itertools::structs::FilterMapOk struct">FilterMapOk</a></div><div class="item-right docblock-short">An iterator adapter to filter and apply a transformation on values within a nested <code>Result::Ok</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FilterOk.html" title="itertools::structs::FilterOk struct">FilterOk</a></div><div class="item-right docblock-short">An iterator adapter to filter values within a nested <code>Result::Ok</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FlattenOk.html" title="itertools::structs::FlattenOk struct">FlattenOk</a></div><div class="item-right docblock-short">An iterator adaptor that flattens <code>Result::Ok</code> values and |
| allows <code>Result::Err</code> values through unchanged.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Format.html" title="itertools::structs::Format struct">Format</a></div><div class="item-right docblock-short">Format all iterator elements lazily, separated by <code>sep</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FormatWith.html" title="itertools::structs::FormatWith struct">FormatWith</a></div><div class="item-right docblock-short">Format all iterator elements lazily, separated by <code>sep</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Group.html" title="itertools::structs::Group struct">Group</a></div><div class="item-right docblock-short">An iterator for the elements in a single group.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.GroupBy.html" title="itertools::structs::GroupBy struct">GroupBy</a></div><div class="item-right docblock-short"><code>GroupBy</code> is the storage for the lazy grouping operation.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.GroupingMap.html" title="itertools::structs::GroupingMap struct">GroupingMap</a></div><div class="item-right docblock-short"><code>GroupingMap</code> is an intermediate struct for efficient group-and-fold operations. |
| It groups elements by their key and at the same time fold each group |
| using some aggregating operation.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Groups.html" title="itertools::structs::Groups struct">Groups</a></div><div class="item-right docblock-short">An iterator that yields the Group iterators.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Interleave.html" title="itertools::structs::Interleave struct">Interleave</a></div><div class="item-right docblock-short">An iterator adaptor that alternates elements from two iterators until both |
| run out.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.InterleaveShortest.html" title="itertools::structs::InterleaveShortest struct">InterleaveShortest</a></div><div class="item-right docblock-short">An iterator adaptor that alternates elements from the two iterators until |
| one of them runs out.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.IntersperseWith.html" title="itertools::structs::IntersperseWith struct">IntersperseWith</a></div><div class="item-right docblock-short">An iterator adaptor to insert a particular value created by a function |
| between each element of the adapted iterator.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.IntoChunks.html" title="itertools::structs::IntoChunks struct">IntoChunks</a></div><div class="item-right docblock-short"><code>ChunkLazy</code> is the storage for a lazy chunking operation.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Iterate.html" title="itertools::structs::Iterate struct">Iterate</a></div><div class="item-right docblock-short">An iterator that infinitely applies function to value and yields results.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.KMergeBy.html" title="itertools::structs::KMergeBy struct">KMergeBy</a></div><div class="item-right docblock-short">An iterator adaptor that merges an abitrary number of base iterators |
| according to an ordering function.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.MergeBy.html" title="itertools::structs::MergeBy struct">MergeBy</a></div><div class="item-right docblock-short">An iterator adaptor that merges the two base iterators in ascending order. |
| If both base iterators are sorted (ascending), the result is sorted.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.MergeJoinBy.html" title="itertools::structs::MergeJoinBy struct">MergeJoinBy</a></div><div class="item-right docblock-short">An iterator adaptor that merge-joins items from the two base iterators in ascending order.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.MultiPeek.html" title="itertools::structs::MultiPeek struct">MultiPeek</a></div><div class="item-right docblock-short">See <a href="../fn.multipeek.html" title="multipeek()"><code>multipeek()</code></a> for more information.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.MultiProduct.html" title="itertools::structs::MultiProduct struct">MultiProduct</a></div><div class="item-right docblock-short">An iterator adaptor that iterates over the cartesian product of |
| multiple iterators of type <code>I</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PadUsing.html" title="itertools::structs::PadUsing struct">PadUsing</a></div><div class="item-right docblock-short">An iterator adaptor that pads a sequence to a minimum length by filling |
| missing elements using a closure.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PeekNth.html" title="itertools::structs::PeekNth struct">PeekNth</a></div><div class="item-right docblock-short">See <a href="../fn.peek_nth.html" title="peek_nth()"><code>peek_nth()</code></a> for more information.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PeekingTakeWhile.html" title="itertools::structs::PeekingTakeWhile struct">PeekingTakeWhile</a></div><div class="item-right docblock-short">An iterator adaptor that takes items while a closure returns <code>true</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Permutations.html" title="itertools::structs::Permutations struct">Permutations</a></div><div class="item-right docblock-short">An iterator adaptor that iterates through all the <code>k</code>-permutations of the |
| elements from an iterator.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Positions.html" title="itertools::structs::Positions struct">Positions</a></div><div class="item-right docblock-short">An iterator adapter to get the positions of each element that matches a predicate.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Powerset.html" title="itertools::structs::Powerset struct">Powerset</a></div><div class="item-right docblock-short">An iterator to iterate through the powerset of the elements from an iterator.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ProcessResults.html" title="itertools::structs::ProcessResults struct">ProcessResults</a></div><div class="item-right docblock-short">An iterator that produces only the <code>T</code> values as long as the |
| inner iterator produces <code>Ok(T)</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Product.html" title="itertools::structs::Product struct">Product</a></div><div class="item-right docblock-short">An iterator adaptor that iterates over the cartesian product of |
| the element sets of two iterators <code>I</code> and <code>J</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PutBack.html" title="itertools::structs::PutBack struct">PutBack</a></div><div class="item-right docblock-short">An iterator adaptor that allows putting back a single |
| item to the front of the iterator.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PutBackN.html" title="itertools::structs::PutBackN struct">PutBackN</a></div><div class="item-right docblock-short">An iterator adaptor that allows putting multiple |
| items in front of the iterator.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RcIter.html" title="itertools::structs::RcIter struct">RcIter</a></div><div class="item-right docblock-short">A wrapper for <code>Rc<RefCell<I>></code>, that implements the <code>Iterator</code> trait.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RepeatCall.html" title="itertools::structs::RepeatCall struct">RepeatCall</a><span class="stab deprecated" title="">Deprecated</span></div><div class="item-right docblock-short">See <a href="../fn.repeat_call.html"><code>repeat_call</code></a> for more information.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RepeatN.html" title="itertools::structs::RepeatN struct">RepeatN</a></div><div class="item-right docblock-short">An iterator that produces <em>n</em> repetitions of an element.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Step.html" title="itertools::structs::Step struct">Step</a><span class="stab deprecated" title="">Deprecated</span></div><div class="item-right docblock-short">An iterator adaptor that steps a number elements in the base iterator |
| for each iteration.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TakeWhileRef.html" title="itertools::structs::TakeWhileRef struct">TakeWhileRef</a></div><div class="item-right docblock-short">An iterator adaptor that borrows from a <code>Clone</code>-able iterator |
| to only pick off elements while the predicate returns <code>true</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Tee.html" title="itertools::structs::Tee struct">Tee</a></div><div class="item-right docblock-short">One half of an iterator pair where both return the same elements.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TupleBuffer.html" title="itertools::structs::TupleBuffer struct">TupleBuffer</a></div><div class="item-right docblock-short">An iterator over a incomplete tuple.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TupleCombinations.html" title="itertools::structs::TupleCombinations struct">TupleCombinations</a></div><div class="item-right docblock-short">An iterator to iterate through all combinations in a <code>Clone</code>-able iterator that produces tuples |
| of a specific size.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TupleWindows.html" title="itertools::structs::TupleWindows struct">TupleWindows</a></div><div class="item-right docblock-short">An iterator over all contiguous windows that produces tuples of a specific size.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Tuples.html" title="itertools::structs::Tuples struct">Tuples</a></div><div class="item-right docblock-short">An iterator that groups the items in tuples of a specific size.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Unfold.html" title="itertools::structs::Unfold struct">Unfold</a></div><div class="item-right docblock-short">See <a href="../fn.unfold.html"><code>unfold</code></a> for more information.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Unique.html" title="itertools::structs::Unique struct">Unique</a></div><div class="item-right docblock-short">An iterator adapter to filter out duplicate elements.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.UniqueBy.html" title="itertools::structs::UniqueBy struct">UniqueBy</a></div><div class="item-right docblock-short">An iterator adapter to filter out duplicate elements.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Update.html" title="itertools::structs::Update struct">Update</a></div><div class="item-right docblock-short">An iterator adapter to apply a mutating function to each element before yielding it.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.WhileSome.html" title="itertools::structs::WhileSome struct">WhileSome</a></div><div class="item-right docblock-short">An iterator adaptor that filters <code>Option<A></code> iterator elements |
| and produces <code>A</code>. Stops on the first <code>None</code> encountered.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.WithPosition.html" title="itertools::structs::WithPosition struct">WithPosition</a></div><div class="item-right docblock-short">An iterator adaptor that wraps each element in an <a href="../enum.Position.html" title="Position"><code>Position</code></a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Zip.html" title="itertools::structs::Zip struct">Zip</a></div><div class="item-right docblock-short">See <a href="../fn.multizip.html" title="multizip"><code>multizip</code></a> for more information.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ZipEq.html" title="itertools::structs::ZipEq struct">ZipEq</a></div><div class="item-right docblock-short">An iterator which iterates two other iterators simultaneously</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ZipLongest.html" title="itertools::structs::ZipLongest struct">ZipLongest</a></div><div class="item-right docblock-short">An iterator which iterates two other iterators simultaneously</div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.Coalesce.html" title="itertools::structs::Coalesce type">Coalesce</a></div><div class="item-right docblock-short">An iterator adaptor that may join together adjacent elements.</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.Dedup.html" title="itertools::structs::Dedup type">Dedup</a></div><div class="item-right docblock-short">An iterator adaptor that removes repeated duplicates.</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.DedupBy.html" title="itertools::structs::DedupBy type">DedupBy</a></div><div class="item-right docblock-short">An iterator adaptor that removes repeated duplicates, determining equality using a comparison function.</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.DedupByWithCount.html" title="itertools::structs::DedupByWithCount type">DedupByWithCount</a></div><div class="item-right docblock-short">An iterator adaptor that removes repeated duplicates, while keeping a count of how many |
| repeated elements were present. This will determine equality using a comparison function.</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.DedupWithCount.html" title="itertools::structs::DedupWithCount type">DedupWithCount</a></div><div class="item-right docblock-short">An iterator adaptor that removes repeated duplicates, while keeping a count of how many |
| repeated elements were present.</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.Duplicates.html" title="itertools::structs::Duplicates type">Duplicates</a></div><div class="item-right docblock-short">An iterator adapter to filter out duplicate elements.</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.DuplicatesBy.html" title="itertools::structs::DuplicatesBy type">DuplicatesBy</a></div><div class="item-right docblock-short">An iterator adapter to filter for duplicate elements.</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.GroupingMapBy.html" title="itertools::structs::GroupingMapBy type">GroupingMapBy</a></div><div class="item-right docblock-short"><code>GroupingMapBy</code> is an intermediate struct for efficient group-and-fold operations.</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.Intersperse.html" title="itertools::structs::Intersperse type">Intersperse</a></div><div class="item-right docblock-short">An iterator adaptor to insert a particular value |
| between each element of the adapted iterator.</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.KMerge.html" title="itertools::structs::KMerge type">KMerge</a></div><div class="item-right docblock-short">An iterator adaptor that merges an abitrary number of base iterators in ascending order. |
| If all base iterators are sorted (ascending), the result is sorted.</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.MapInto.html" title="itertools::structs::MapInto type">MapInto</a></div><div class="item-right docblock-short">An iterator adapter to apply <code>Into</code> conversion to each element.</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.MapOk.html" title="itertools::structs::MapOk type">MapOk</a></div><div class="item-right docblock-short">An iterator adapter to apply a transformation within a nested <code>Result::Ok</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.MapResults.html" title="itertools::structs::MapResults type">MapResults</a><span class="stab deprecated" title="">Deprecated</span></div><div class="item-right docblock-short">See <a href="type.MapOk.html" title="MapOk"><code>MapOk</code></a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.Merge.html" title="itertools::structs::Merge type">Merge</a></div><div class="item-right docblock-short">An iterator adaptor that merges the two base iterators in ascending order. |
| If both base iterators are sorted (ascending), the result is sorted.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="itertools" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
