[API Proposal]: Introduce extensions for all AlternateLookup built in collections and key String
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
Research direction
Start by reviewing the proposed DictionaryExtensions API and the referenced issue #110505 about DefaultInterpolatedStringHandler. Compare the proposal with the built-in collections supporting AlternateLookup and determine the scope for extending them and key String. Done means the API design is resolved for the requested collection operations.
Written by the indexing model from the issue text.
Description
Background and motivation
I would like to propose an extension for all collections that are supporting AlternateLookup. For example Dictionary<string, TValue>.
It will use DefaultInterpolatedStringHandler as key and once this is merged, can became allocation free only with recompiling code to .NET 10.
API Proposal
namespace System.Collections.Generic;
public static class DictionaryExtensions
{
public static bool TryGetValue<TValue>(this Dictionary<string, TValue> dictionary, ref DefaultInterpolatedStringHandler key, out TValue value)
{
if (dictionary.TryGetAlternateLookup(out Dictionary<string, TValue>.AlternateLookup<ReadOnlySpan<char>> span))
{
var result = span.TryGetValue(key.Text, out value);
key.Clear();
return result;
}
return dictionary.TryGetValue(key.ToStringAndClear(), out value);
}
public static bool TryAdd<TValue>(this Dictionary<string, TValue> dictionary, ref DefaultInterpolatedStringHandler key, TValue value)
{
if (dictionary.TryGetAlternateLookup(out Dictionary<string, TValue>.AlternateLookup<ReadOnlySpan<char>> span))
{
var result = span.TryAdd(key.Text, value);
key.Clear();
return result;
}
return dictionary.TryAdd(key.ToStringAndClear(), value);
}
public static bool ContainsKey<TValue>(this Dictionary<string, TValue> dictionary, ref DefaultInterpolatedStringHandler key)
{
if (dictionary.TryGetAlternateLookup(out Dictionary<string, TValue>.AlternateLookup<ReadOnlySpan<char>> span))
{
var result = span.ContainsKey(key.Text);
key.Clear();
return result;
}
return dictionary.ContainsKey(key.ToStringAndClear());
}
public static bool Remove<TValue>(this Dictionary<string, TValue> dictionary, ref DefaultInterpolatedStringHandler key)
{
if (dictionary.TryGetAlternateLookup(out Dictionary<string, TValue>.AlternateLookup<ReadOnlySpan<char>> span))
{
var result = span.Remove(key.Text);
key.Clear();
return result;
}
return dictionary.Remove(key.ToStringAndClear());
}
}
API Usage
// Fancy the value
var c = new Dictionary<string, int>();
c.TryAdd($"{something}fancy{thing}",42);
// Getting the values out
c.TryGet($"{11}_{Guid.Empty}", out var value)
//Remove
...
//ContainsKey
....
Alternative Designs
Once DefaultInterpolatedStringHandler exposed Text and Clear, this extension can be build by everybody in his codebase.
Risks
Somebody already defined such extension in his codebase.
- Dominant language
- C#
- Stars
- 18.3k
- Forks
- 5.6k
- PR merge metrics
- PR metrics pending
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from dotnet/runtime
-
agentic-workflows untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
area-System.Reflection blocking-clean-ci-optional Known Build Error os-mac-os-x untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
area-CodeGen-coreclr untriaged
Difficulty 1/5 Under an hour Newbie friendliness 92/100
-
agentic-workflows untriaged
Difficulty 1/5 Under an hour Newbie friendliness 78/100
-
area-VM-meta-mono untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
-
:watch: Not Triaged 11.0 fundamentals/subsvc
Difficulty 2/5 1-3 hours Newbie friendliness 92/100
dotnet/AspNetCore.Docs#37699 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
SubtitleEdit/subtitleedit#15108 · 1 comment ·
-
area/docs-content Bug pulumi/docs
Difficulty 1/5 1-3 hours Newbie friendliness 94/100
-
Create parent directories only after the containment check in InstallHelper.TryExtractToDirectory Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
PowerShell/PSResourceGet#2056 ·