[API Proposal]: ToOrderedDictionary

Open
#110,286 1 comment 10 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
csharp
Domain
api, backend-api-design

Research direction

Start by comparing the proposed ToOrderedDictionary overloads with the existing ToDictionary, ToFrozenDictionary, ToImmutableDictionary, and ToImmutableSortedDictionary extensions. Use the API usage example and comparer overload to define the expected behavior; done means both proposed overloads are available for OrderedDictionary and behave consistently with the analogous dictionary methods.

Written by the indexing model from the issue text.

Description

api-suggestion area-System.Collections
Background and motivation

We have ToDictionary, ToFrozenDictionary, ToImmutableDictionaryand ToImmutableSortedDictionary extension method for other dictionary types already. Having similar extension methods for OrderedDictionary would allow us to use OrderedDictionary in places where we use other dictionary types with the same level of convenience.

API Proposal

public static OrderedDictionary<TKey, TElement> ToOrderedDictionary<TSource, TKey, TElement>(this IEnumerable<TSource> source, Func<TSource, TKey> keySelector, Func<TSource, TElement> elementSelector) where TKey : notnull => ToOrderedDictionary(source, keySelector, elementSelector, null);
public static OrderedDictionary<TKey, TElement> ToOrderedDictionary<TSource, TKey, TElement>(this IEnumerable<TSource> source, Func<TSource, TKey> keySelector, Func<TSource, TElement> elementSelector, IEqualityComparer<TKey>? comparer) where TKey : notnull
API Usage
List<char> list = ['a', 'b', 'c'];
OrderedDictionary<char, double> orderedDictionary = list.ToOrderedDictionary(f => f, char.GetNumericValue);
Alternative Designs

No response

Risks

No response

Dominant language
C#
Stars
18.3k
Forks
5.6k
PR metrics pending

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from dotnet/runtime

All issues in dotnet/runtime

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.