Microsoft.AspNetCore.Routing.Abstractions

Defines the contract that a class must implement to transform route values while building a URI.

Transforms the specified route value to a string for inclusion in a URI.

The route value to transform. The transformed value.

A marker interface for types that are associated with route parameters.

Defines the contract that a class must implement in order to check whether a URL parameter value is valid for a constraint.

Determines whether the URL parameter contains a valid value for this constraint.

An object that encapsulates information about the HTTP request. The router that this constraint belongs to. The name of the parameter that is being checked. A dictionary that contains the parameters for the URL. An object that indicates whether the constraint check is being performed when an incoming request is being handled or when a URL is being generated. true if the URL parameter contains a valid value; otherwise, false.

Defines a contract for a handler of a route.

Gets a to handle the request, based on the provided .

The associated with the current request. The associated with the current routing match. A , or null if the handler cannot handle this request.

Interface for implementing a router.

Asynchronously routes based on the current .

A instance.

Returns the URL that is associated with the route details provided in

A instance. A object. Can be null.

A feature interface for routing functionality.

Gets or sets the associated with the current request.

Defines a contract to generate absolute and related URIs based on endpoint routing.

Generating URIs in endpoint routing occurs in two phases. First, an address is bound to a list of endpoints that match the address. Secondly, each endpoint's RoutePattern is evaluated, until a route pattern that matches the supplied values is found. The resulting output is combined with the other URI parts supplied to the link generator and returned. The methods provided by the type are general infrastructure, and support the standard link generator functionality for any type of address. The most convenient way to use is through extension methods that perform operations for a specific address type.

Generates a URI with an absolute path based on the provided values and .

Generates a URI with an absolute path based on the provided values.

The address type. The address value. Used to resolve endpoints. The route values. Used to expand parameters in the route template. An optional URI path base. Prepended to the path in the resulting URI. An optional URI fragment. Appended to the resulting URI. An optional . Settings on provided object override the settings with matching names from RouteOptions. A URI with an absolute path, or null.

Generates an absolute URI based on the provided values and .

The address type. The associated with the current request. The address value. Used to resolve endpoints. The route values. Used to expand parameters in the route template. The values associated with the current request. Optional. The URI scheme, applied to the resulting URI. Optional. If not provided, the value of will be used. The URI host/authority, applied to the resulting URI. Optional. If not provided, the value will be used. See the remarks section for details about the security implications of the . An optional URI path base. Prepended to the path in the resulting URI. If not provided, the value of will be used. An optional URI fragment. Appended to the resulting URI. An optional . Settings on provided object override the settings with matching names from RouteOptions. A URI with an absolute path, or null. The value of should be a trusted value. Relying on the value of the current request can allow untrusted input to influence the resulting URI unless the Host header has been validated. See the deployment documentation for instructions on how to properly validate the Host header in your deployment environment.

Generates an absolute URI based on the provided values.

The address type. The address value. Used to resolve endpoints. The route values. Used to expand parameters in the route template. The URI scheme, applied to the resulting URI. The URI host/authority, applied to the resulting URI. See the remarks section for details about the security implications of the . An optional URI path base. Prepended to the path in the resulting URI. An optional URI fragment. Appended to the resulting URI. An optional . Settings on provided object override the settings with matching names from RouteOptions. An absolute URI, or null. The value of should be a trusted value. Relying on the value of the current request can allow untrusted input to influence the resulting URI unless the Host header has been validated. See the deployment documentation for instructions on how to properly validate the Host header in your deployment environment.

Configures options for generated URLs.

Gets or sets a value indicating whether all generated paths URLs are lowercase. Use to configure the behavior for query strings.

Gets or sets a value indicating whether a generated query strings are lowercase. This property will be false unless is also true.

Gets or sets a value indicating whether a trailing slash should be appended to the generated URLs.

A context object for .

Creates a new instance of for the provided .

The associated with the current request.

Gets or sets the handler for the request. An should set when it matches.

Gets the associated with the current request.

Gets or sets the associated with the current context.

Information about the current routing path.

Creates a new instance of instance.

Creates a new instance of instance with values copied from .

The other instance to copy.

Creates a new instance of instance with the specified values.

The values.

Gets the data tokens produced by routes on the current routing path.

Gets the list of instances on the current routing path.

Gets the values produced by routes on the current routing path.

Creates a snapshot of the current state of the before appending to , merging into , and merging into . Call to restore the state of this to the state at the time of calling .

An to append to . If null, then will not be changed. A to merge into . If null, then will not be changed. A to merge into . If null, then will not be changed. A that captures the current state.

A snapshot of the state of a instance.

Creates a new instance of for .

The . The data tokens. The routers. The route values.

Restores the to the captured state.

Indicates whether ASP.NET routing is processing a URL from an HTTP request or generating a URL.

A URL from a client is being processed.

A URL is being created based on the route definition.

Extension methods for related to routing.

Gets the associated with the provided .

The associated with the current request. The .

Gets a route value from associated with the provided .

The associated with the current request. The key of the route value. The corresponding route value, or null.

A context for virtual path generation operations.

Creates a new instance of .

The associated with the current request. The set of route values associated with the current request. The set of new values provided for virtual path generation.

Creates a new instance of .

The associated with the current request. The set of route values associated with the current request. The set of new values provided for virtual path generation. The name of the route to use for virtual path generation.

Gets the set of route values associated with the current request.

Gets the associated with the current request.

Gets the name of the route to use for virtual path generation.

Gets or sets the set of new values provided for virtual path generation.

Represents information about the route and virtual path that are the result of generating a URL with the ASP.NET routing middleware.

Initializes a new instance of the class.

The object that is used to generate the URL. The generated URL.

Initializes a new instance of the class.

The object that is used to generate the URL. The generated URL. The collection of custom values.

Gets the collection of custom values for the .

Gets or sets the that was used to generate the URL.

Gets or sets the URL that was generated from the .

Initializes a fast . This constructor does not cache the helper. For caching, use .

Gets the backing .

Gets (or sets in derived types) the property name.

Gets the property value getter.

Gets the property value setter.

Returns the property value for the specified .

The object whose property value will be returned. The property value.

Sets the property value for the specified .

The object whose property value will be set. The property value.

Creates and caches fast property helpers that expose getters for every public get property on the specified type.

The type to extract property accessors for. A cached array of all public properties of the specified type.

Creates and caches fast property helpers that expose getters for every non-hidden get property on the specified type. excludes properties defined on base types that have been hidden by definitions using the new keyword.

The type to extract property accessors for. A cached array of all public properties of the specified type.

Creates a single fast property getter. The result is not cached.

propertyInfo to extract the getter for. a fast getter. This method is more memory efficient than a dynamically compiled lambda, and about the same speed.

Creates a single fast property getter which is safe for a null input object. The result is not cached.

propertyInfo to extract the getter for. a fast getter. This method is more memory efficient than a dynamically compiled lambda, and about the same speed.

Creates a single fast property setter for reference types. The result is not cached.

propertyInfo to extract the setter for. a fast getter. This method is more memory efficient than a dynamically compiled lambda, and about the same speed. This only works for reference types.

Given an object, adds each instance property with a public get method as a key and its associated value to a dictionary. If the object is already an instance, then a copy is returned.

The implementation of PropertyHelper will cache the property accessors per-type. This is faster when the same type is used multiple times with ObjectToDictionary.

The type to extract property accessors for. The cache to store results in. Use to use the default cache. Use to avoid caching. The cache to store results in. Use if the calling type does not have its own independent cache. Use to avoid caching. A cached array of all public properties of the specified type.

Creates and caches fast property helpers that expose getters for every public get property on the specified type.

The type to extract property accessors for. The cache to store results in. Use to use the default cache. Use to avoid caching. A cached array of all public properties of the specified type.

Invoked as part of contract for hot reload.