[API Proposal]: FileSystemGlobbing FilePatternMatch.Index

[CheloXL]

Background and motivation

I need to know which include pattern actually matches the FilePatternMatch returned matcher.Execute.

I'm proposing to add an additional property, Index, to the FilePatternMatch, that would be the index where that pattern was added.

With this information, I'm able to know the original pattern.

API Proposal

namespace Microsoft.Extensions.FileSystemGlobbing
{
    public struct FilePatternMatch : IEquatable<FilePatternMatch>
    {
        ...
        public int Index { get; }
        ...
    }
}

API Usage

var result = matcher.Execute(...);
foreach (var match in result.Files)
{
    Console.WriteLine(match.Index);
}

Alternative Designs

Another option could be to simply add a Pattern property, that would hold the original pattern. Not sure which one is best, since FilePatternMatch is a struct (in memory terms).

Risks

This is not a breaking change (it only extends the api), nor I'm aware of any performance regressions this could cause.

[ghost]

Tagging subscribers to this area: @dotnet/area-system-io
See info in area-owners.md if you want to be subscribed.

Issue Details

---

Background and motivation

I need to know which include pattern actually matches the FilePatternMatch returned matcher.Execute.

I'm proposing to add an additional property, Index, to the FilePatternMatch, that would be the index where that pattern was added.

With this information, I'm able to know the original pattern.

API Proposal

namespace Microsoft.Extensions.FileSystemGlobbing
{
    public struct FilePatternMatch : IEquatable<FilePatternMatch>
    {
        ...
        public int Index { get; }
        ...
    }
}

API Usage

var result = matcher.Execute(...);
foreach (var match in result.Files)
{
    Console.WriteLine(match.Index);
}

Alternative Designs

Another option could be to simply add a Pattern property, that would hold the original pattern. Not sure which one is best, since FilePatternMatch is a struct (in memory terms).

Risks

This is not a breaking change (it only extends the api), nor I'm aware of any performance regressions this could cause.

Author:	CheloXL
Assignees:	-
Labels:	api-suggestion, area-System.IO, untriaged
Milestone:	-

[jozkee]

An Index wouldn't be very useful as Matcher doesn't expose the include patterns. Including the Pattern in FilePatternMatch makes more sense to me.
There's an open request for improving Globbing in .NET (#21362), I think this proposal should be considered as part of that effort.