[API Proposal]: ReadOnlySpan<char> based overload for Uri.CheckHostName
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- csharp
- Domain
- api, backend-api-design
Research direction
Start at the existing Uri.CheckHostName(string?) entry point and review how its hostname validation is exposed. Compare the proposed ReadOnlySpan overload with the existing behavior and API usage; done means the proposal is implemented with equivalent hostname classification and validation for spans.
Written by the indexing model from the issue text.
Description
Background and motivation
This method wraps some useful checks that can determine both the type and validity of hostnames. When checking the validity of the hostname part of a larger string part of a path or url string (such as the hostname portion of a UNC path), it could be useful to perform this check on just a ReadOnly<char> slice. Recreating to avoid the allocation would be annoying when the method already exists.
API Proposal
namespace System;
public class Uri : ISpanFormattable, ISerializable
{
public static UriHostNameType CheckHostName(string? name);
+ public static UriHostNameType CheckHostName(ReadOnlySpan<char> name)
}
API Usage
string uncPath = @"\\192.168.0.1\someShare";
int hostnameEnd = uncPath[2..].IndexOf('\\') + 2;
ReadOnlySpan<char> hostNameSpan = uncPath.AsSpan()[2..hostnameEnd];
UriHostNameType hostNameType = Uri.CheckHostName(hostNameSpan);
Alternative Designs
More comprehensive parsing/validation tools for string paths could be introduced.
Risks
Slightly larger API surface.
- 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 ·