Deconstruction in foreach over Dictionary

Question

Is it possible in C#7 to use deconstruction in a foreach-loop over a Dictionary? Something like this:

var dic = new Dictionary<string, int>{ ["Bob"] = 32, ["Alice"] = 17 };
foreach (var (name, age) in dic)
{
    Console.WriteLine($"{name} is {age} years old.");
}

It doesn't seem to work with Visual Studio 2017 RC4 and .NET Framework 4.6.2:

error CS1061: 'KeyValuePair' does not contain a definition for 'Deconstruct' and no extension method 'Deconstruct' accepting a first argument of type 'KeyValuePair' could be found (are you missing a using directive or an assembly reference?)

This is still a problem in VS Code 1.61.0 with C# extension 1.23.16. — Vivraan, Oct 20 '21 at 05:33

Ryan Lundy · Answer 1 · 2018-07-12T11:26:53.660

85

If you don't like having to write the Deconstruct method, especially if you only need it in one place, here's how to do it as a one-liner with LINQ:

Using your original dictionary:

var dic = new Dictionary<string, int>{ ["Bob"] = 32, ["Alice"] = 17 };

You can do it like this:

foreach (var (name, age) in dic.Select(x => (x.Key, x.Value)))
{
    Console.WriteLine($"{name} is {age} years old.");
}

edited Jul 12 '18 at 11:26

answered Jul 11 '18 at 09:03

Ryan Lundy

204,559
37
180
211

2

this will also work when joining via LINQ, when you end up by having an anon class with one field for each model in the result; – genuinefafa Apr 14 '21 at 02:36

score 82 · Accepted Answer · edited May 23 '17 at 11:54

82

First you have to add an extension method for KeyValuePair:

public static void Deconstruct<T1, T2>(this KeyValuePair<T1, T2> tuple, out T1 key, out T2 value)
{
    key = tuple.Key;
    value = tuple.Value;
}

Then you will get a different error:

error CS8179: Predefined type 'System.ValueTuple`2' is not defined or imported

According to this answer you have to install the NuGet package System.ValueTuple.

Then it should compile. However Visual Studio 2017 RC4 will say that it cannot resolve the symbol names name and age. They should hopefully fix this in a future update.

edited May 23 '17 at 11:54

Community

1
1

answered Mar 02 '17 at 07:47

gartenriese

4,131
6
36
60

Not sure why RC4 is giving you that error. `name` and `age` resolve just fine and the code works when I try it. – David Arno Mar 02 '17 at 10:08
1

So `static void Deconstruct(this KeyValuePair` is going to be an extension method I'll have to write over and over in each project once VS2017 drops? Wonderful. – Tinister Mar 02 '17 at 22:51
1

@Tinister: Maybe they'll have it implemented for the release next week. – gartenriese Mar 03 '17 at 13:01
2

@Tinister, why rewrite it every time? Create a nuget package and import it into your projects... – David Arno Mar 07 '17 at 09:28
1

@Tinister you should already be pushing your own reusable code into your own library – Dave Cousineau May 31 '19 at 17:35

score 47 · Answer 3 · answered Mar 28 '19 at 07:42

47

Deconstruct of KeyValuePair<TKey,TValue> is implemented in .NET Core 2.0, but not in .NET Framework (up to 4.8 preview) unfortunately.

answered Mar 28 '19 at 07:42

hillin

1,603
15
21

15

Deconstruct on KeyValuePair will be included into .NET Standard 2.1 – altso Jun 24 '19 at 17:19
2

That's why some of my projects that target multiple frameworks (including .net-core-2.0) sometimes support it and another time not. I thought I'm loosing my mind. – t3chb0t Nov 13 '19 at 16:10
2

It works in .NET 5. – Gábor Jan 16 '22 at 21:54

Deconstruction in foreach over Dictionary

3 Answers3

Linked