Some help understanding “yield”

by

A method using yield return must be declared as returning one of the following two interfaces:

IEnumerable<SomethingAppropriate>
IEnumerator<SomethingApropriate>

(thanks Jon and Marc for pointing out IEnumerator)

Example:

public IEnumerable<AClass> YourMethod()
{
    foreach (XElement header in headersXml.Root.Elements())
    {
        yield return (ParseHeader(header));                
    }
}

yield is a lazy producer of data, only producing another item after the first has been retrieved, whereas returning a list will return everything in one go.

So there is a difference, and you need to declare the method correctly.

For more information, read Jon’s answer here, which contains some very useful links.

More Related Contents:

  1. yield statement implementation
  2. What is the yield keyword used for in C#?
  3. IEnumerable and Recursion using yield return
  4. Using the iterator variable of foreach loop in a lambda expression – why fails?
  5. Pair-wise iteration in C# or sliding window enumerator
  6. Why can’t yield return appear inside a try block with a catch?
  7. What does “yield break;” do in C#?
  8. Performance of nested yield in a tree
  9. Return all enumerables with yield return at once; without looping through
  10. When NOT to use yield (return) [duplicate]
  11. Asynchronous iterator Task
  12. Pair-wise iteration in C#, or sliding window enumerator
  13. In C#, why can’t an anonymous method contain a yield statement?
  14. implementing a state machine using the “yield” keyword
  15. WWW/UnityWebRequest POST/GET request won’t return the latest data from server/url
  16. Object dispose in IDisposable class
  17. How to Convert JSON object to Custom C# object?
  18. Good or bad practice for Dialogs in wpf with MVVM?
  19. How can you strip non-ASCII characters from a string? (in C#)
  20. ShouldSerialize*() vs *Specified Conditional Serialization Pattern
  21. Passing strings from C# to C++ DLL and back — minimal example
  22. C# ‘is’ operator performance
  23. C# Thread Termination and Thread.Abort()
  24. Get Substring – everything before certain char
  25. What’s the quickest way to compute log2 of an integer in C#?
  26. How do I measure how long a function is running?
  27. What is the difference between .Wait() vs .GetAwaiter().GetResult()?
  28. NUnit expected exceptions
  29. Read from .msg files [closed]
  30. How do i replace accents (german) in .NET

Leave a Comment