Microsoft.AspNetCore.Http.Abstractions

Represents an HTTP request error

Initializes a new instance of the class.

The message to associate with this exception. The HTTP status code to associate with this exception.

Initializes a new instance of the class with the set to 400 Bad Request.

The message to associate with this exception

Initializes a new instance of the class.

The message to associate with this exception. The HTTP status code to associate with this exception. The inner exception to associate with this exception

Initializes a new instance of the class with the set to 400 Bad Request.

The message to associate with this exception The inner exception to associate with this exception

Gets the HTTP status code for this exception.

Represents the underlying connection for a request.

Gets or sets a unique identifier to represent this connection.

Gets or sets the IP address of the remote target. Can be null.

Gets or sets the port of the remote target.

Gets or sets the IP address of the local host.

Gets or sets the port of the local host.

Gets or sets the client certificate.

Retrieves the client certificate.

Asynchronously returns an . Can be null.

Close connection gracefully.

Defines settings used to create a cookie.

The name of the cookie.

The cookie path.

Determines the value that will set on .

The domain to associate the cookie with.

Determines the value that will set on .

Indicates whether a cookie is accessible by client-side script.

Determines the value that will set on .

The SameSite attribute of the cookie. The default value is

Determines the value that will set on .

The policy that will be used to determine . This is determined from the passed to .

Gets or sets the lifespan of a cookie.

Gets or sets the max-age for the cookie.

Indicates if this cookie is essential for the application to function correctly. If true then consent policy checks may be bypassed. The default value is false.

Creates the cookie options from the given .

The . The cookie options.

Creates the cookie options from the given with an expiration based on and .

The . The time to use as the base for computing . The cookie options.

Determines how cookie security properties are set.

If the URI that provides the cookie is HTTPS, then the cookie will only be returned to the server on subsequent HTTPS requests. Otherwise if the URI that provides the cookie is HTTP, then the cookie will be returned to the server on all HTTP and HTTPS requests. This value ensures HTTPS for all authenticated requests on deployed servers, and also supports HTTP for localhost development and for servers that do not have HTTPS support.

Secure is always marked true. Use this value when your login page and all subsequent pages requiring the authenticated identity are HTTPS. Local development will also need to be done with HTTPS urls.

Secure is not marked true. Use this value when your login page is HTTPS, but other pages on the site which are HTTP also require authentication information. This setting is not recommended because the authentication information provided with an HTTP request may be observed and used by other computers on your local network or wireless connection.

Contains extension methods for modifying an instance.

Add new values. Each item remains a separate array entry.

The to use. The header name. The header value.

Quotes any values containing commas, and then comma joins all of the values with any existing values.

The to use. The header name. The header values.

Get the associated values from the collection separated into individual values. Quoted values will not be split, and the quotes will be removed.

The to use. The header name. the associated values from the collection separated into individual values, or StringValues.Empty if the key is not present.

Quotes any values containing commas, and then comma joins all of the values.

The to use. The header name. The header values.

Convenience methods for writing to the response.

Writes the given text to the response body. UTF-8 encoding will be used.

The . The text to write to the response. Notifies when request operations should be cancelled. A task that represents the completion of the write operation.

Writes the given text to the response body using the given encoding.

The . The text to write to the response. The encoding to use. Notifies when request operations should be cancelled. A task that represents the completion of the write operation.

HttpRequest extensions for working with request trailing headers.

Gets the request "Trailer" header that lists which trailers to expect after the body.

Indicates if the request supports receiving trailer headers.

Checks if the request supports trailers and they are available to be read now. This does not mean that there are any trailers to read.

Gets the requested trailing header from the response. Check or a NotSupportedException may be thrown. Check or an InvalidOperationException may be thrown.

Contains extension methods for modifying the `Trailer` response header and trailing headers in an .

Adds the given trailer name to the 'Trailer' response header. This must happen before the response headers are sent.

Indicates if the server supports sending trailer headers for this response.

Adds the given trailer header to the trailers collection to be sent at the end of the response body. Check or an InvalidOperationException may be thrown.

Provides correct handling for FragmentString value when needed to generate a URI string

Represents the empty fragment string. This field is read-only.

Initialize the fragment string with a given value. This value must be in escaped and delimited format with a leading '#' character.

The fragment string to be assigned to the Value property.

The escaped fragment string with the leading '#' character

True if the fragment string is not empty

Provides the fragment string escaped in a way which is correct for combining into the URI representation. A leading '#' character will be included unless the Value is null or empty. Characters which are potentially dangerous are escaped.

The fragment string value

Returns an FragmentString given the fragment as it is escaped in the URI format. The string MUST NOT contain any value that is not a fragment.

The escaped fragment as it appears in the URI format. The resulting FragmentString

Returns an FragmentString given the fragment as from a Uri object. Relative Uri objects are not supported.

The Uri object The resulting FragmentString

Evaluates if the current fragment is equal to another fragment .

A to compare. if the fragments are equal.

Evaluates if the current fragment is equal to an object .

An object to compare. if the fragments are equal.

Gets a hash code for the value.

The hash code as an .

Evaluates if one fragment is equal to another.

A instance. A instance. if the fragments are equal.

Evalutes if one framgent is not equal to another.

A instance. A instance. if the fragments are not equal.

Represents the host portion of a URI can be used to construct URI's properly formatted and encoded for use in HTTP headers.

Creates a new HostString without modification. The value should be Unicode rather than punycode, and may have a port. IPv4 and IPv6 addresses are also allowed, and also may have ports.

Creates a new HostString from its host and port parts.

The value should be Unicode rather than punycode. IPv6 addresses must use square braces. A positive, greater than 0 value representing the port in the host string.

Returns the original value from the constructor.

Returns true if the host is set.

Returns the value of the host part of the value. The port is removed if it was present. IPv6 addresses will have brackets added if they are missing.

The host portion of the value.

Returns the value of the port part of the host, or null if none is found.

The port portion of the value.

Returns the value as normalized by ToUriComponent().

The value as normalized by .

Returns the value properly formatted and encoded for use in a URI in a HTTP header. Any Unicode is converted to punycode. IPv6 addresses will have brackets added if they are missing.

The value formated for use in a URI or HTTP header.

Creates a new HostString from the given URI component. Any punycode will be converted to Unicode.

The URI component string to create a from. The that was created.

Creates a new HostString from the host and port of the give Uri instance. Punycode will be converted to Unicode.

The to create a from. The that was created.

Matches the host portion of a host header value against a list of patterns. The host may be the encoded punycode or decoded unicode form so long as the pattern uses the same format.

Host header value with or without a port. A set of pattern to match, without ports. The port on the given value is ignored. The patterns should not have ports. The patterns may be exact matches like "example.com", a top level wildcard "*" that matches all hosts, or a subdomain wildcard like "*.example.com" that matches "abc.example.com:443" but not "example.com:443". Matching is case insensitive. if matches any of the patterns.

Compares the equality of the Value property, ignoring case.

The to compare against. if they have the same value.

Compares against the given object only if it is a HostString.

The to compare against. if they have the same value.

Gets a hash code for the value.

The hash code as an .

Compares the two instances for equality.

The left parameter. The right parameter. if both 's have the same value.

Compares the two instances for inequality.

The left parameter. The right parameter. if both 's values are not equal.

Parses the current value. IPv6 addresses will have brackets added if they are missing.

The value to get the parts of. The portion of the which represents the host. The portion of the which represents the port.

Encapsulates all HTTP-specific information about an individual HTTP request.

Gets the collection of HTTP features provided by the server and middleware available on this request.

Gets the object for this request.

Gets information about the underlying connection for this request.

Gets an object that manages the establishment of WebSocket connections for this request.

Gets or sets the user for this request.

Gets or sets a key/value collection that can be used to share data within the scope of this request.

Gets or sets the that provides access to the request's service container.

Notifies when the connection underlying this request is aborted and thus request operations should be cancelled.

Gets or sets a unique identifier to represent this request in trace logs.

Gets or sets the object used to manage user session data for this request.

Aborts the connection underlying this request.

Contains methods to verify the request method of an HTTP request.

HTTP "CONNECT" method.

HTTP "DELETE" method.

HTTP "GET" method.

HTTP "HEAD" method.

HTTP "OPTIONS" method.

HTTP "PATCH" method.

HTTP "POST" method.

HTTP "PUT" method.

HTTP "TRACE" method.

Returns a value that indicates if the HTTP request method is CONNECT.

The HTTP request method. if the method is CONNECT; otherwise, .

Returns a value that indicates if the HTTP request method is DELETE.

The HTTP request method. if the method is DELETE; otherwise, .

Returns a value that indicates if the HTTP request method is GET.

The HTTP request method. if the method is GET; otherwise, .

Returns a value that indicates if the HTTP request method is HEAD.

The HTTP request method. if the method is HEAD; otherwise, .

Returns a value that indicates if the HTTP request method is OPTIONS.

The HTTP request method. if the method is OPTIONS; otherwise, .

Returns a value that indicates if the HTTP request method is PATCH.

The HTTP request method. if the method is PATCH; otherwise, .

Returns a value that indicates if the HTTP request method is POST.

The HTTP request method. if the method is POST; otherwise, .

Returns a value that indicates if the HTTP request method is PUT.

The HTTP request method. if the method is PUT; otherwise, .

Returns a value that indicates if the HTTP request method is TRACE.

The HTTP request method. if the method is TRACE; otherwise, .

Returns the equivalent static instance, or the original instance if none match. This conversion is optional but allows for performance optimizations when comparing method values elsewhere.

Returns a value that indicates if the HTTP methods are the same.

The first HTTP request method to compare. The second HTTP request method to compare. if the methods are the same; otherwise, .

Contains methods to verify the request protocol version of an HTTP request.

HTTP protocol version 0.9.

HTTP protocol version 1.0.

HTTP protocol version 1.1.

HTTP protocol version 2.

HTTP protcol version 3.

Returns a value that indicates if the HTTP request protocol is HTTP/0.9.

The HTTP request protocol. if the protocol is HTTP/0.9; otherwise, .

Returns a value that indicates if the HTTP request protocol is HTTP/1.0.

The HTTP request protocol. if the protocol is HTTP/1.0; otherwise, .

Returns a value that indicates if the HTTP request protocol is HTTP/1.1.

The HTTP request protocol. if the protocol is HTTP/1.1; otherwise, .

Returns a value that indicates if the HTTP request protocol is HTTP/2.

The HTTP request protocol. if the protocol is HTTP/2; otherwise, .

Returns a value that indicates if the HTTP request protocol is HTTP/3.

The HTTP request protocol. if the protocol is HTTP/3; otherwise, .

Gets the HTTP request protocol for the specified .

The version. A HTTP request protocol.

Represents the incoming side of an individual HTTP request.

Gets the for this request.

Gets or sets the HTTP method.

The HTTP method.

Gets or sets the HTTP request scheme.

The HTTP request scheme.

Returns true if the RequestScheme is https.

true if this request is using https; otherwise, false.

Gets or sets the Host header. May include the port.

The Host header.

Gets or sets the base path for the request. The path base should not end with a trailing slash.

The base path for the request.

Gets or sets the request path from RequestPath.

The request path from RequestPath.

Gets or sets the raw query string used to create the query collection in Request.Query.

The raw query string.

Gets the query value collection parsed from Request.QueryString.

The query value collection parsed from Request.QueryString.

Gets or sets the request protocol (e.g. HTTP/1.1).

The request protocol.

Gets the request headers.

The request headers.

Gets the collection of Cookies for this request.

The collection of Cookies for this request.

Gets or sets the Content-Length header.

The value of the Content-Length header, if any.

Gets or sets the Content-Type header.

The Content-Type header.

Gets or sets the request body .

The request body .

Gets the request body .

The request body .

Checks the Content-Type header for form types.

true if the Content-Type header represents a form content type; otherwise, false.

Gets or sets the request body as a form.

Reads the request body if it is a form.

Gets the collection of route values for this request.

The collection of route values for this request.

Represents the outgoing side of an individual HTTP request.

Gets the for this response.

Gets or sets the HTTP response code.

Gets the response headers.

Gets or sets the response body .

Gets the response body

The response body .

Gets or sets the value for the Content-Length response header.

Gets or sets the value for the Content-Type response header.

Gets an object that can be used to manage cookies for this response.

Gets a value indicating whether response headers have been sent to the client.

Adds a delegate to be invoked just before response headers will be sent to the client. Callbacks registered here run in reverse order.

Callbacks registered here run in reverse order. The last one registered is invoked first. The reverse order is done to replicate the way middleware works, with the inner-most middleware looking at the response first. The delegate to execute. A state object to capture and pass back to the delegate.

Adds a delegate to be invoked just before response headers will be sent to the client. Callbacks registered here run in reverse order.

Adds a delegate to be invoked after the response has finished being sent to the client.

The delegate to invoke. A state object to capture and pass back to the delegate.

Registers an object for disposal by the host once the request has finished processing.

The object to be disposed.

Registers an object for asynchronous disposal by the host once the request has finished processing.

The object to be disposed asynchronously.

Adds a delegate to be invoked after the response has finished being sent to the client.

The delegate to invoke.

Returns a temporary redirect response (HTTP 302) to the client.

The URL to redirect the client to. This must be properly encoded for use in http headers where only ASCII characters are allowed.

Returns a redirect response (HTTP 301 or HTTP 302) to the client.

The URL to redirect the client to. This must be properly encoded for use in http headers where only ASCII characters are allowed. True if the redirect is permanent (301), otherwise false (302).

Starts the response by calling OnStarting() and making headers unmodifiable.

Flush any remaining response headers, data, or trailers. This may throw if the response is in an invalid state such as a Content-Length mismatch.

Provides access to the current , if one is available.

This interface should be used with caution. It relies on which can have a negative performance impact on async calls. It also creates a dependency on "ambient state" which can make testing more difficult.

Gets or sets the current . Returns if there is no active .

Provides methods to create and dispose of instances.

Creates an instance for the specified set of HTTP features.

The collection of HTTP features to set on the created instance. The instance.

Releases resources held by the .

The to dispose.

Defines middleware that can be added to the application's request pipeline.

Request handling method.

The for the current request. The delegate representing the remaining middleware in the request pipeline. A that represents the execution of this middleware.

Provides methods to create middleware.

Creates a middleware instance for each request.

The concrete of the . The instance.

Releases a instance at the end of each request.

The instance to release.

Defines a contract that represents the result of an HTTP endpoint.

Write an HTTP response reflecting the result.

The for the current request. A task that represents the asynchronous execute operation.

Interface for accepting request media types.

Gets a list of the allowed request content types. If the incoming request does not have a Content-Type with one of these values, the request will be rejected with a 415 response.

Gets the type being read from the request.

Gets a value that determines if the request body is optional.

Interface marking attributes that specify a parameter should be bound using the request body.

Gets whether empty input should be rejected or treated as valid.

Interface marking attributes that specify a parameter should be bound using the request headers.

The request header name.

Interface marking attributes that specify a parameter should be bound using the request query string.

The name of the query string field.

Interface marking attributes that specify a parameter should be bound using route-data from the current request.

The name.

Interface marking attributes that specify a parameter should be bound using request services.

Defines a contract for outline the response type returned from an endpoint.

Gets the optimistic return type of the action.

Gets the HTTP status code of the response.

Gets the content types supported by the metadata.

Defines a contract used to specify a collection of tags in .

Gets the collection of tags associated with the endpoint.

Provides correct escaping for Path and PathBase values when needed to reconstruct a request or redirect URI string

Represents the empty path. This field is read-only.

Initialize the path string with a given value. This value must be in unescaped format. Use PathString.FromUriComponent(value) if you have a path value which is in an escaped format.

The unescaped path to be assigned to the Value property.

The unescaped path value

True if the path is not empty

Provides the path string escaped in a way which is correct for combining into the URI representation.

The escaped path value

Provides the path string escaped in a way which is correct for combining into the URI representation.

The escaped path value

Returns an PathString given the path as it is escaped in the URI format. The string MUST NOT contain any value that is not a path.

The escaped path as it appears in the URI format. The resulting PathString

Returns an PathString given the path as from a Uri object. Relative Uri objects are not supported.

The Uri object The resulting PathString

Determines whether the beginning of this instance matches the specified .

The to compare. true if value matches the beginning of this string; otherwise, false.

Determines whether the beginning of this instance matches the specified when compared using the specified comparison option.

The to compare. One of the enumeration values that determines how this and value are compared. true if value matches the beginning of this string; otherwise, false.

Determines whether the beginning of this instance matches the specified and returns the remaining segments.

The to compare. The remaining segments after the match. true if value matches the beginning of this string; otherwise, false.

Determines whether the beginning of this instance matches the specified when compared using the specified comparison option and returns the remaining segments.

The to compare. One of the enumeration values that determines how this and value are compared. The remaining segments after the match. true if value matches the beginning of this string; otherwise, false.

Determines whether the beginning of this instance matches the specified and returns the matched and remaining segments.

The to compare. The matched segments with the original casing in the source value. The remaining segments after the match. true if value matches the beginning of this string; otherwise, false.

Determines whether the beginning of this instance matches the specified when compared using the specified comparison option and returns the matched and remaining segments.

The to compare. One of the enumeration values that determines how this and value are compared. The matched segments with the original casing in the source value. The remaining segments after the match. true if value matches the beginning of this string; otherwise, false.

Adds two PathString instances into a combined PathString value.

The combined PathString value

Combines a PathString and QueryString into the joined URI formatted string value.

The joined URI formatted string value

Compares this PathString value to another value. The default comparison is StringComparison.OrdinalIgnoreCase.

The second PathString for comparison. True if both PathString values are equal

Compares this PathString value to another value using a specific StringComparison type

The second PathString for comparison The StringComparison type to use True if both PathString values are equal

Compares this PathString value to another value. The default comparison is StringComparison.OrdinalIgnoreCase.

The second PathString for comparison. True if both PathString values are equal

Returns the hash code for the PathString value. The hash code is provided by the OrdinalIgnoreCase implementation.

The hash code

Operator call through to Equals

The left parameter The right parameter True if both PathString values are equal

Operator call through to Equals

The left parameter The right parameter True if both PathString values are not equal

The left parameter The right parameter The ToString combination of both values

Operator call through to Add

The left parameter The right parameter The PathString combination of both values

Operator call through to Add

The left parameter The right parameter The PathString combination of both values

Implicitly creates a new PathString from the given string.

Implicitly calls ToString().

Provides correct handling for QueryString value when needed to reconstruct a request or redirect URI string

Represents the empty query string. This field is read-only.

Initialize the query string with a given value. This value must be in escaped and delimited format with a leading '?' character.

The query string to be assigned to the Value property.

The escaped query string with the leading '?' character

True if the query string is not empty

Provides the query string escaped in a way which is correct for combining into the URI representation. A leading '?' character will be included unless the Value is null or empty. Characters which are potentially dangerous are escaped.

The query string value

Returns an QueryString given the query as it is escaped in the URI format. The string MUST NOT contain any value that is not a query.

The escaped query as it appears in the URI format. The resulting QueryString

Returns an QueryString given the query as from a Uri object. Relative Uri objects are not supported.

The Uri object The resulting QueryString

Create a query string with a single given parameter name and value.

The un-encoded parameter name The un-encoded parameter value The resulting QueryString

Creates a query string composed from the given name value pairs.

The resulting QueryString

Creates a query string composed from the given name value pairs.

The resulting QueryString

Concatenates to the current query string.

The to concatenate. The concatenated .

Concatenates a query string with and to the current query string.

The name of the query string to concatenate. The value of the query string to concatenate. The concatenated .

Evalutes if the current query string is equal to .

The to compare. if the query strings are equal.

Evaluates if the current query string is equal to an object .

An object to compare. if the query strings are equal.

Gets a hash code for the value.

The hash code as an .

Evaluates if one query string is equal to another.

A instance. A instance. if the query strings are equal.

Evaluates if one query string is not equal to another.

A instance. A instance. if the query strings are not equal.

Concatenates and into a single query string.

A instance. A instance. The concatenated .

A function that can process an HTTP request.

The for the request. A task that represents the completion of request processing.

The result of creating a from a

Creates a new instance of .

Gets the

Gets endpoint metadata inferred from creating the

Represents a logical endpoint in an application.

Creates a new instance of .

The delegate used to process requests for the endpoint. The endpoint . May be null. The informational display name of the endpoint. May be null.

Gets the informational display name of this endpoint.

Gets the collection of metadata associated with this endpoint.

Gets the delegate used to process requests for the endpoint.

Returns a string representation of the endpoint.

Extension methods to expose Endpoint on HttpContext.

Extension method for getting the for the current request.

The context. The .

Extension method for setting the for the current request.

The context. The .

A collection of arbitrary metadata associated with an endpoint.

instances contain a list of metadata items of arbitrary types. The metadata items are stored as an ordered collection with items arranged in ascending order of precedence.

An empty .

Creates a new .

The metadata items.

Creates a new .

The metadata items.

Gets the item at .

The index of the item to retrieve. The item at .

Gets the count of metadata items.

Gets the most significant metadata item of type .

The type of metadata to retrieve. The most significant metadata of type or null.

Gets the metadata items of type in ascending order of precedence.

The type of metadata. A sequence of metadata items of .

Gets an of all metadata items.

An of all metadata items.

Gets an of all metadata items.

An of all metadata items.

Gets an of all metadata items.

An of all metadata items.

Enumerates the elements of an .

Gets the element at the current position of the enumerator

Releases all resources used by the .

Advances the enumerator to the next element of the .

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Sets the enumerator to its initial position, which is before the first element in the collection.

A feature interface for endpoint routing. Use to access an instance associated with the current request.

Gets or sets the selected for the current request.

A feature interface for routing values. Use to access the values associated with the current request.

Gets or sets the associated with the current request.

A collection of constants for HTTP status codes. Status Codes listed at http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml

HTTP status code 100.

HTTP status code 101.

HTTP status code 102.

HTTP status code 200.

HTTP status code 201.

HTTP status code 202.

HTTP status code 203.

HTTP status code 204.

HTTP status code 205.

HTTP status code 206.

HTTP status code 207.

HTTP status code 208.

HTTP status code 226.

HTTP status code 300.

HTTP status code 301.

HTTP status code 302.

HTTP status code 303.

HTTP status code 304.

HTTP status code 305.

HTTP status code 306.

HTTP status code 307.

HTTP status code 308.

HTTP status code 400.

HTTP status code 401.

HTTP status code 402.

HTTP status code 403.

HTTP status code 404.

HTTP status code 405.

HTTP status code 406.

HTTP status code 407.

HTTP status code 408.

HTTP status code 409.

HTTP status code 410.

HTTP status code 411.

HTTP status code 412.

HTTP status code 413.

HTTP status code 414.

HTTP status code 415.

HTTP status code 416.

HTTP status code 417.

HTTP status code 418.

HTTP status code 419.

HTTP status code 422.

HTTP status code 423.

HTTP status code 424.

HTTP status code 426.

HTTP status code 428.

HTTP status code 429.

HTTP status code 431.

HTTP status code 451.

HTTP status code 500.

HTTP status code 501.

HTTP status code 502.

HTTP status code 503.

HTTP status code 504.

HTTP status code 505.

HTTP status code 506.

HTTP status code 507.

HTTP status code 508.

HTTP status code 510.

HTTP status code 511.

Manages the establishment of WebSocket connections for a specific HTTP request.

Gets a value indicating whether the request is a WebSocket establishment request.

Gets the list of requested WebSocket sub-protocols.

Transitions the request to a WebSocket connection.

A task representing the completion of the transition.

Transitions the request to a WebSocket connection using the specified sub-protocol.

The sub-protocol to use. A task representing the completion of the transition.

'{0}' is not available.

No public '{0}' or '{1}' method found for middleware of type '{2}'.

'{0}' or '{1}' does not return an object of type '{2}'.

The '{0}' or '{1}' method's first argument must be of type '{2}'.

Multiple public '{0}' or '{1}' methods are available.

The path in '{0}' must start with '/'.

Unable to resolve service for type '{0}' while attempting to Invoke middleware '{1}'.

The '{0}' method must not have ref or out parameters.

The value must be greater than zero.

No service for type '{0}' has been registered.

'{0}' failed to create middleware of type '{1}'.

Types that implement '{0}' do not support explicit arguments.

Argument cannot be null or empty.

An element with the key '{0}' already exists in the {1}.

The type '{0}' defines properties '{1}' and '{2}' which differ only by casing. This is not supported by {3} which uses case-insensitive comparisons.

A base class for building an new .

Gets or sets the delegate used to process requests for the endpoint.

Gets or sets the informational display name of this endpoint.

Gets the collection of metadata associated with this endpoint.

Creates an instance of from the .

The created .

Builds conventions that will be used for customization of instances.

This interface is used at application startup to customize endpoints for the application.

Adds the specified convention to the builder. Conventions are used to customize instances.

The convention to add to the builder.

Extension methods for the .

Branches the request pipeline based on matches of the given request path. If the request path starts with the given path, the branch is executed.

The instance. The request path to match. The branch to take for positive path matches. The instance.

Branches the request pipeline based on matches of the given request path. If the request path starts with the given path, the branch is executed.

The instance. The request path to match. The branch to take for positive path matches. The instance.

Branches the request pipeline based on matches of the given request path. If the request path starts with the given path, the branch is executed.

The instance. The request path to match. if false, matched path would be removed from Request.Path and added to Request.PathBase. The branch to take for positive path matches. The instance.

Represents a middleware that maps a request path to a sub-request pipeline.

Creates a new instance of .

The delegate representing the next middleware in the request pipeline. The middleware options.

Executes the middleware.

The for the current request. A task that represents the execution of this middleware.

Options for the .

The path to match.

The branch taken for a positive match.

If false, matched path would be removed from Request.Path and added to Request.PathBase Defaults to false.

Represents a middleware that runs a sub-request pipeline when a given predicate is matched.

Creates a new instance of .

The delegate representing the next middleware in the request pipeline. The middleware options.

Executes the middleware.

The for the current request. A task that represents the execution of this middleware.

Options for the .

The user callback that determines if the branch should be taken.

The branch taken for a positive match.

Represents a middleware that extracts the specified path base from request path and postpend it to the request path base.

Creates a new instance of .

The delegate representing the next middleware in the request pipeline. The path base to extract.

Executes the middleware.

The for the current request. A task that represents the execution of this middleware.

Extension methods for the .

Branches the request pipeline based on the result of the given predicate.

Invoked with the request environment to determine if the branch should be taken Configures a branch to take

Extension methods for adding terminal middleware.

Adds a terminal middleware delegate to the application's request pipeline.

The instance. A delegate that handles the request.

Extension methods for adding middleware.

Adds a middleware delegate defined in-line to the application's request pipeline. If you aren't calling the next function, use instead. Prefer using for better performance as shown below:


            app.Use((context, next) =>
            {
                return next(context);
            });

The instance. A function that handles the request and calls the given next function. The instance.

Adds a middleware delegate defined in-line to the application's request pipeline. If you aren't calling the next function, use instead.

The instance. A function that handles the request and calls the given next function. The instance.

Extension methods for adding typed middleware.

Adds a middleware type to the application's request pipeline.

The middleware type. The instance. The arguments to pass to the middleware type instance's constructor. The instance.

Adds a middleware type to the application's request pipeline.

The instance. The middleware type. The arguments to pass to the middleware type instance's constructor. The instance.

Extension methods for .

Adds a middleware that extracts the specified path base from request path and postpend it to the request path base.

The instance. The path base to extract. The instance.

Extension methods for .

Conditionally creates a branch in the request pipeline that is rejoined to the main pipeline.

Invoked with the request environment to determine if the branch should be taken Configures a branch to take

Defines a class that provides the mechanisms to configure an application's request pipeline.

Gets or sets the that provides access to the application's service container.

Gets the set of HTTP features the application's server provides.

Gets a key/value collection that can be used to share data between middleware.

Adds a middleware delegate to the application's request pipeline.

The middleware delegate. The .

Creates a new that shares the of this .

The new .

Builds the delegate used by this application to process HTTP requests.

The request handling delegate.

A marker interface which can be used to identify CORS metadata.

An type for route values.

Creates a new from the provided array. The new instance will take ownership of the array, and may mutate it.

The items array. A new .

Creates an empty .

Creates a initialized with the specified .

An object to initialize the dictionary. The value can be of type or or an object with public properties as key-value pairs. If the value is a dictionary or other of , then its entries are copied. Otherwise the object is interpreted as a set of key-value pairs where the property names are keys, and property values are the values, and copied into the dictionary. Only public instance non-index properties are considered.

Gets the comparer for this dictionary.

This will always be a reference to

Attempts to remove and return the value that has the specified key from the .

The key of the element to remove and return. When this method returns, contains the object removed from the , or null if key does not exist. true if the object was removed successfully; otherwise, false.

Attempts to the add the provided and to the dictionary.

The key. The value. Returns true if the value was added. Returns false if the key was already present.

Instantiates a new enumerator with the values provided in .

A .

Releases resources used by the .

Unescape a URL path

The byte span represents a UTF8 encoding url path. The byte span where unescaped url path is copied to. Whether we are doing form encoding or not. The length of the byte sequence of the unescaped url path.

Unescape a URL path in place.

The byte span represents a UTF8 encoding url path. Whether we are doing form encoding or not. The number of the bytes representing the result. The unescape is done in place, which means after decoding the result is the subset of the input span.

Unescape the percent-encodings

The iterator point to the first % char The place to write to The byte array Whether we are doing form encodoing

Read the percent-encoding and try unescape it. The operation first peek at the character the iterator points at. If it is % the is then moved on to scan the following to characters. If the two following characters are hexadecimal literals they will be unescaped and the value will be returned. If the first character is not % the iterator will be removed beyond the location of % and -1 will be returned. If the following two characters can't be successfully unescaped the iterator will be move behind the % and -1 will be returned.

The value to read The byte array Whether we are decoding a form or not. Will escape '/' if we are doing form encoding The unescaped byte if success. Otherwise return -1.

Read the next char and convert it into hexadecimal value. The index will be moved to the next byte no matter whether the operation successes.

The index of the byte in the buffer to read The byte span from which the hex to be read The hexadecimal value if successes, otherwise -1.

Unescape a URL path

The escape sequences is expected to be well-formed UTF-8 code units. The char span where unescaped url path is copied to. The length of the char sequence of the unescaped url path. Form Encoding is not supported compared to the for performance gains, as current use-cases does not require it.

Unescape a URL path in place.

The escape sequences is expected to be well-formed UTF-8 code units. The number of the chars representing the result. The unescape is done in place, which means after decoding the result is the subset of the input span. Form Encoding is not supported compared to the for performance gains, as current use-cases does not require it.

Unescape the percent-encodings

The iterator point to the first % char The place to write to The char array

The value to read The char array The unescaped char if success. Otherwise return -1.

Read the next char and convert it into hexadecimal value. The index will be moved to the next char no matter whether the operation successes.

The index of the char in the buffer to read The char span from which the hex to be read The hexadecimal value if successes, otherwise -1.

Helper code for the various activator services.

Instantiate a type with constructor arguments provided directly and/or from an .

The service provider used to resolve dependencies The type to activate Constructor arguments not provided by the . An activated object of type instanceType

Create a delegate that will instantiate a type with constructor arguments provided directly and/or from an .

The type to activate The types of objects, in order, that will be passed to the returned function as its second parameter A factory that will instantiate instanceType using an and an argument array containing objects matching the types defined in argumentTypes

Instantiate a type with constructor arguments provided directly and/or from an .

The type to activate The service provider used to resolve dependencies Constructor arguments not provided by the . An activated object of type T

Retrieve an instance of the given type from the service provider. If one is not found then instantiate it directly.

The type of the service The service provider used to resolve dependencies The resolved service or created instance

Retrieve an instance of the given type from the service provider. If one is not found then instantiate it directly.

The service provider The type of the service The resolved service or created instance

Marks the constructor to be used when activating type using .

The result of .

The to get service arguments from. Additional constructor arguments. The instantiated type.

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 underlying type.

The type info 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 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 info to extract property accessors for. A cached array of all public properties of the specified type.

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.