Skip to main content

Iterator Adapters in Rust

An Iterator that takes another iterator and returns a new one is called an iterator adapter. The name "adapter" comes from one of the GoF's design patterns, the adapter pattern. However, in reality, it corresponds more to the decorator pattern, so if you pay too much attention to the name, you might get confused about its purpose. So it's better not to worry too much about the name. Enough complaining about the name, what does an iterator adapter do?

An iterator adapter adds a task to be performed when the iterator iterates. This will be easier to understand when you see an example. The map function is one of the famous adapters. The iterator returned by the map function for those who have used functional languages iterates over new values transformed from the original values.

Besides, various adapters are already implemented in the standard library. Among them, the most frequently used are those that are convenient to use with loops. Examples include the filter that only returns values that meet the condition, take that returns only a specified number of values, skip that omits a few values and returns the rest, and step_by that iterates by skipping a few values. Using these adapters with loops can easily express complex condition handling.

In addition, cycle that makes it iterate forever without end, and inspect that only causes side effects without giving any transformation to the iterating values are also frequently used.

There is one thing to be careful about when using adapters. What the adapter returns is also an iterator. It does not perform the tasks specified by the adapter until the iterator is actually consumed. In other words, it performs lazy evaluation, which postpones execution until the value is actually needed. Therefore, the following code does not output any value on the screen because it does not use the iterator returned by inspect.

Then, there might be a question here. If the iterator spit out by the iterator adapter performs lazy evaluation, what happens to the iterator used as input to the adapter? In other languages which also implement the concept of iterator adapter, this can be a big problem. Fortunately, Rust prevents these kinds of problems from occurring using ownership. An iterator adapter is a function that takes an iterator and returns a new one. In other words, it takes ownership of the iterator. If it was a function that takes a reference to an iterator, it would have said that it borrows the iterator to create a new one. Therefore, the caller of the adapter can no longer use the iterator that was put into the adapter as an argument.

In this article, we introduced what an iterator adapter is and some commonly used adapters. In reality, there are many more adapters implemented in the standard library. At first glance, you might wonder where this will be used. But take a good look at the program you're creating now. There are surprisingly many cases where iterators are used. And among them, there are many cases where the code becomes cleaner when using an iterator adapter. Moreover, in Rust, problems arising from using iterator adapters in other languages do not occur, so there's no need to worry.

This article is translated from my post written in Korean. Since the post was written two years ago, there might be more sophisticated explanations for iterator adapters nowadays. However, this article seems still be sufficient to help understand iterator adapters.


Popular posts from this blog

[C++] Handling Exceptions in Constructors

When you use RAII idiom, there are often situations where constructors have to do complex tasks. These complex tasks can sometimes fail, resulting in throwing exceptions. This raises a concern: Is it okay to throw exceptions in constructors? The first concern is memory leaks. Fortunately, memory leaks do not occur. Variables created on the stack are released through stack unwinding, and if an exception occurs during heap allocation with the new operator, the new operator automatically deallocates the memory and returns nullptr . The next concern is whether the destructor of the member variables will be called correctly. However, this is also not a problem. When an exception occurs, member variables can be divided into three categories: fully initialized member variables, member variables being initialized, and uninitialized member variables. Fully initialized member variables have had their constructors called and memory allocations completed successfully. In the example code, t

Difference Between the clear Command in Linux and Mac

I've been writing a series of posts about CSI Sequences, but we rarely use CSI Sequences directly. However, there is a CSI Sequence that we use unknowingly. It's the clear command that clears the screen. The clear command basically uses two types of CSI sequences. One is CSI H ( Cu rsor P osition, a.k.a CUP); it moves the cursor to the beginning of the screen. The cursor is at the top-left corner after the command ends, thanks to CUP. The second CSI Sequence is CSI 2 J ( E rase in D isplay, a.k.a. ED), which is used to clear the entire screen. Linux and Mac use these two sequences; they behave the same way up to this point. However, Linux's clear and Mac's differ in their subsequent actions. In a nutshell, Linux's clear clears the scrollback buffer, while Mac's does not. Linux's one prints CSI 3 J after the two sequences. CSI 3 J is an extension of the Escape Sequence introduced by xterm that removes lines stored in the scrollback buffer. Since be