Share via

IEndpointComparerPolicy Interface

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Routing.Matching
Assembly:
Microsoft.AspNetCore.Routing.dll
Package:
Microsoft.AspNetCore.Routing v2.2.0
Package:
Microsoft.AspNetCore.App.Ref v3.0.1
Package:
Microsoft.AspNetCore.App.Ref v3.1.10
Package:
Microsoft.AspNetCore.App.Ref v5.0.0
Package:
Microsoft.AspNetCore.App.Ref v6.0.6
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.0
Package:
Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3
Source:
IEndpointComparerPolicy.cs

A MatcherPolicy interface that can be implemented to sort endpoints. Implementations of IEndpointComparerPolicy must inherit from MatcherPolicy and should be registered in the dependency injection container as singleton services of type MatcherPolicy.

public interface class IEndpointComparerPolicy
public interface IEndpointComparerPolicy
type IEndpointComparerPolicy = interface
Public Interface IEndpointComparerPolicy
Derived

Remarks

Candidates in a CandidateSet are sorted based on their priority. Defining a IEndpointComparerPolicy adds an additional criterion to the sorting operation used to order candidates.

As an example, the implementation of HttpMethodMatcherPolicy implements IEndpointComparerPolicy to ensure that endpoints matching specific HTTP methods are sorted with a higher priority than endpoints without a specific HTTP method requirement.

Properties

Comparer

Gets an IComparer<T> that will be used to sort the endpoints.

Applies to