Click here to Skip to main content
Click here to Skip to main content
Technical Blog

Tagged as

IEnumerable: Lazy and Dangerous

, 12 Jul 2014 Apache
Rate this:
Please Sign up or sign in to vote.
IEnumerable: Lazy and Dangerous

Time and time again, I am burnt by the same bug in my code.

There are two kinds of enumerables in .NET: enumerators and generators. Enumerators go over some collection and return its items. Enumerator will always return the same values, no matter how many times you iterate over it. This only changes when someone adds or removes items from the collection.

Generators, on the other hand, compute new values every time. They may or may not be the same, depending on how the generator is built and what happened around it. All those neat LINQ methods like “where” and “select” are in fact generators.

For example,

IEnumerable<string> names = new[] { "Paris", "Berlin", "London" }; // enumerator
IEnumerable<City> cities = names.Select(name=>new City(name)); // generator

Every time you do foreach (var city in cities), a different set of cities is produced. E.g.

foreach (var city in cities) city.Visited = true;
...
foreach (var city in cities)
{
    Console.WriteLine(city.Visited); // prints false
}

One can easily convert a generator to an enumerator by adding ToList(), ToArray(), or ToDictionary(). This will create a “real” data structure that is not modified.

var cityList = names.Select(name=>new City(name)).ToList();
foreach (var city in cityList) city.Visited = true;
...
foreach (var city in cityList)
{
    Console.WriteLine(city.Visited); // prints true
}

Even more subtle issues can occur when using conditions:

cityList[0].Visited = true;
var visitedCities = cityList.Where(city=>city.Visited);
Console.WriteLine( visitedCities.Count() ); // 1
...
cityList[0].Visited = false;
Console.WriteLine( visitedCities.Count() ); // 0

This is an obvious case of hidden dependency. We modified something inside cityList, but it “magically” affects similarly unrelated visitedCities. Hidden dependencies are evil, because they are, well, hidden, and people tend to forget about them.

The most annoying part is that generators and enumerators look exactly the same, and it may be quite difficult, or even impossible to tell whether particular IEnumerable is a generator or an enumerator. Functional style programming assumes read-only objects, so it does not matter, but throwing in any modifiable state creates a dangerous mix.

It does not mean one should not use IEnumerable in stateful scenarios, but it is better to be careful, you have been warned!

PS From the Future (2014). Resharper has a warning for multiple enumerations of an IEnumerable. If you pay attention to the warning, your chances of been burnt by this bug will be greatly reduced. Unfortunately, Resharper costs money, and to the best of my knowledge out-of-the-box versions of Visual Studio/C# compiler do not have such warning.

License

This article, along with any associated source code and files, is licensed under The Apache License, Version 2.0

Share

About the Author

Ivan Krivyakov
Technical Lead Thomson Reuters
United States United States
Ivan is a hands-on software architect/technical lead working for Thomson Reuters in the New York City area. At present I am mostly building complex multi-threaded WPF application for the financial sector, but I am also interested in cloud computing, web development, mobile development, etc.
 
Please visit my web site: www.ikriv.com.

Comments and Discussions

 
GeneralMy vote of 5 Pinprofessionalmr. Duan14-Jul-14 17:51 
GeneralMy vote of 5 PinmemberDarkStarHarry14-Jul-14 4:53 
GeneralMy vote of 5 PinmemberOleg A.Lukin13-Jul-14 20:44 
GeneralMy vote of 1 PinprotectorMarc Clifton13-Jul-14 4:17 
GeneralMy vote of 5 PinprofessionalCatchExAs12-Jul-14 7:12 
GeneralRe: My vote of 5 PinmemberIvan Krivyakov12-Jul-14 16:30 
GeneralMy vote of 1 PinmemberStephen M Russell12-Jul-14 4:30 
GeneralRe: My vote of 1 PinmemberIvan Krivyakov12-Jul-14 5:27 
GeneralMy vote of 2 PinmemberStephen M Russell11-Jul-14 23:56 
GeneralRe: My vote of 2 PinmemberIvan Krivyakov12-Jul-14 5:35 
Question[My vote of 2] Lots of things incorrect with no guidance/solution PinmemberWilliam E. Kempf11-Jul-14 5:35 
AnswerRe: [My vote of 2] Lots of things incorrect with no guidance/solution [modified] PinmemberIvan Krivyakov11-Jul-14 13:52 
GeneralMy vote of 5 PinmemberKlaus Luedenscheidt10-Jul-14 19:46 
GeneralRe: My vote of 5 PinmemberIvan Krivyakov12-Jul-14 16:33 
GeneralMy vote of 4 Pinprofessional_Noctis_10-Jul-14 17:18 
GeneralRe: My vote of 4 PinmemberIvan Krivyakov10-Jul-14 17:22 
GeneralRe: My vote of 4 Pinprofessional_Noctis_10-Jul-14 18:57 
GeneralRe: My vote of 4 Pinprofessional_Noctis_12-Jul-14 15:35 
GeneralRe: My vote of 4 PinmemberIvan Krivyakov12-Jul-14 16:33 
GeneralRe: My vote of 4 Pinprofessional_Noctis_12-Jul-14 19:39 
GeneralMy vote of 5 PinmemberJay R. Wren15-Feb-11 3:16 
GeneralIEnumerable semantics Pinmembersupercat99-Feb-11 9:23 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web02 | 2.8.1411028.1 | Last Updated 12 Jul 2014
Article Copyright 2011 by Ivan Krivyakov
Everything else Copyright © CodeProject, 1999-2014
Layout: fixed | fluid