Microsoft.AspNetCore.WebUtilities

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.

Encodes and decodes using base64 url encoding.

Encodes supplied data into Base64 and replaces any URL encodable characters into non-URL encodable characters.

Data to be encoded. Base64 encoded string modified with non-URL encodable characters

Decodes supplied string by replacing the non-URL encodable characters with URL encodable characters and then decodes the Base64 string.

The string to be decoded. The decoded data.

A Stream that wraps another stream and allows reading lines. The data is buffered in memory.

Creates a new stream.

The stream to wrap. Size of buffer in bytes.

Creates a new stream.

The stream to wrap. Size of buffer in bytes. ArrayPool for the buffer.

The currently buffered data.

Ensures that the buffer is not empty.

Returns true if the buffer is not empty; false otherwise.

Ensures that the buffer is not empty.

Cancellation token. Returns true if the buffer is not empty; false otherwise.

Ensures that a minimum amount of buffered data is available.

Minimum amount of buffered data. Returns true if the minimum amount of buffered data is available; false otherwise.

Ensures that a minimum amount of buffered data is available.

Minimum amount of buffered data. Cancellation token. Returns true if the minimum amount of buffered data is available; false otherwise.

Reads a line. A line is defined as a sequence of characters followed by a carriage return immediately followed by a line feed. The resulting string does not contain the terminating carriage return and line feed.

Maximum allowed line length. A line.

Maximum allowed line length. Cancellation token. A line.

A Stream that wraps another stream and enables rewinding by buffering the content as it is read. The content is buffered in memory up to a certain size and then spooled to a temp file on disk. The temp file will be deleted on Dispose.

Initializes a new instance of .

The wrapping . The maximum size to buffer in memory.

Initializes a new instance of .

The wrapping . The maximum size to buffer in memory. The maximum size that will be buffered before this throws. Provides the temporary directory to which files are buffered to.

Initializes a new instance of .

The wrapping . The maximum size to buffer in memory. The maximum size that will be buffered before this throws. Provides the temporary directory to which files are buffered to. The to use.

Initializes a new instance of .

The wrapping . The maximum size to buffer in memory. The maximum size that will be buffered before this throws. The temporary directory to which files are buffered to.

Initializes a new instance of .

The wrapping . The maximum size to buffer in memory. The maximum size that will be buffered before this throws. The temporary directory to which files are buffered to. The to use.

The maximum amount of memory in bytes to allocate before switching to a file on disk.

Defaults to 32kb.

Gets a value that determines if the contents are buffered entirely in memory.

Gets a value that determines where the contents are buffered on disk.

The total bytes read from and buffered by the stream so far, it will not represent the full data length until the stream is fully buffered. e.g. using stream.DrainAsync().

A that buffers content to be written to disk. Use to write buffered content to a target .

Initializes a new instance of .

The maximum amount of memory in bytes to allocate before switching to a file on disk. Defaults to 32kb. The maximum amount of bytes that the is allowed to buffer. Provides the location of the directory to write buffered contents to. When unspecified, uses the value specified by the environment variable ASPNETCORE_TEMP if available, otherwise uses the value returned by .

The maximum amount of memory in bytes to allocate before switching to a file on disk.

Defaults to 32kb.

Drains buffered content to .

The to drain buffered contents to. The . A that represents the asynchronous drain operation.

Drains buffered content to .

The to drain buffered contents to. The . A that represents the asynchronous drain operation.

Represents a file multipart section

Creates a new instance of the class

The section from which to create the Reparses the content disposition header

Creates a new instance of the class

The section from which to create the An already parsed content disposition header

Gets the original section from which this object was created

Gets the file stream from the section body

Gets the name of the section

Gets the name of the file from the section

Represents a form multipart section

Creates a new instance of the class

The section from which to create the Reparses the content disposition header

Creates a new instance of the class

The section from which to create the An already parsed content disposition header

Gets the original section from which this object was created

The form name

Gets the form value

The form value

Gets the form value

The cancellation token. The form value

Used to read an 'application/x-www-form-urlencoded' form. Internally reads from a PipeReader.

Initializes a new instance of .

The to read from.

Initializes a new instance of .

The to read from. The .

The limit on the number of form values to allow in ReadForm or ReadFormAsync.

The limit on the length of form keys.

The limit on the length of form values.

Parses an HTTP form body.

The . The collection containing the parsed HTTP form body.

Used to read an 'application/x-www-form-urlencoded' form.

Gets the default value for . Defaults to 1024.

Gets the default value for . Defaults to 2,048 bytes, which is approximately 2KB.

Gets the default value for . Defaults to 4,194,304 bytes, which is approximately 4MB.

Initializes a new instance of .

The data to read.

Initializes a new instance of .

The data to read. The to use.

Initializes a new instance of .

The to read. Assumes a utf-8 encoded stream.

Initializes a new instance of .

The to read. The character encoding to use.

Initializes a new instance of .

The to read. The character encoding to use. The to use.

The limit on the number of form values to allow in ReadForm or ReadFormAsync.

The limit on the length of form keys.

The limit on the length of form values.

Reads the next key value pair from the form. For unbuffered data use the async overload instead.

The next key value pair, or null when the end of the form is reached.

Asynchronously reads the next key value pair from the form.

The next key value pair, or null when the end of the form is reached.

Parses text from an HTTP form body.

The collection containing the parsed HTTP form body.

Parses an HTTP form body.

The . The collection containing the parsed HTTP form body.

A to read the HTTP request stream.

Initializes a new instance of .

The HTTP request . The character encoding to use.

Initializes a new instance of .

The HTTP request . The character encoding to use. The minimum buffer size.

Initializes a new instance of .

The HTTP request . The character encoding to use. The minimum buffer size. The byte array pool to use. The char array pool to use.

Writes to the HTTP response using the supplied . It does not write the BOM and also does not close the stream.

Initializes a new instance of .

The HTTP response . The character encoding to use.

Initializes a new instance of .

The HTTP response . The character encoding to use. The minimum buffer size.

Initializes a new instance of .

The HTTP response . The character encoding to use. The minimum buffer size. The byte array pool. The char array pool.

This API supports infrastructure and is not intended to be used directly from your code. This API may change or be removed in future releases.

Reads multipart form content from the specified .

Gets the default value for . Defaults to 16.

Gets the default value for . Defaults to 16,384 bytes, which is approximately 16KB.

Initializes a new instance of .

The multipart boundary. The containing multipart data.

Initializes a new instance of .

The multipart boundary. The containing multipart data. The minimum buffer size to use.

The limit for the number of headers to read.

The combined size limit for headers per multipart section.

The optional limit for the body length of each multipart section. The hosting server is responsible for limiting the overall body length.

Reads the next .

The token to monitor for cancellation requests. The default value is .

Creates a stream that reads until it reaches the given boundary pattern.

The . The boundary pattern to use.

Creates a stream that reads until it reaches the given boundary pattern.

The . The boundary pattern to use. The ArrayPool pool to use for temporary byte arrays.

A multipart section read by .

Gets the value of the Content-Type header.

Gets the value of the Content-Disposition header.

Gets or sets the multipart header collection.

Gets or sets the body.

The position where the body starts in the total multipart body. This may not be available if the total multipart body is not seekable.

Various extensions for converting multipart sections

Converts the section to a file section

The section to convert A file section

Converts the section to a form section

The section to convert A form section

Retrieves and parses the content disposition header from a section

The section from which to retrieve A if the header was found, null otherwise

Various extension methods for dealing with the section body stream

Reads the body of the section as a string

The section to read from The body steam as string

Reads the body of the section as a string

The section to read from The cancellationt token. The body steam as string

Provides methods for parsing and manipulating query strings.

Append the given query key and value to the URI.

The base URI. The name of the query key. The query value. The combined result. is null. is null. is null.

Append the given query keys and values to the URI.

The base URI. A dictionary of query keys and values to append. The combined result. is null. is null.

Append the given query keys and values to the URI.

The base URI. A collection of query names and values to append. The combined result. is null. is null.

Append the given query keys and values to the URI.

The base URI. A collection of name value query pairs to append. The combined result. is null. is null.

Parse a query string into its component key and value parts.

The raw query string value, with or without the leading '?'. A collection of parsed keys and values.

Parse a query string into its component key and value parts.

The raw query string value, with or without the leading '?'. A collection of parsed keys and values, null if there are no entries.

Provides access to HTTP status code reason phrases as listed in http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml.

Gets the reason phrase for the specified status code.

The status code. The reason phrase, or if the status code is unknown.

HTTP extension methods for .

Reads the specified to the end. This API is effective when used in conjunction with buffering. It allows a buffered request stream to be synchronously read after it has been completely drained.

The to completely read. The token to monitor for cancellation requests.

Reads the specified to the end. This API is effective when used in conjunction with buffering. It allows a buffered request stream to be synchronously read after it has been completely drained.

The to completely read. The maximum number of bytes to read. Throws if the is larger than this limit. The token to monitor for cancellation requests.

Reads the specified to the end. This API is effective when used in conjunction with buffering. It allows a buffered request stream to be synchronously read after it has been completely drained.

The to completely read. The byte array pool to use. The maximum number of bytes to read. Throws if the is larger than this limit. The token to monitor for cancellation requests.

An enumerable that can supply the name/value pairs from a URI query string.

Constructs an instance of .

The query string.

Constructs an instance of .

The query string.

Retrieves an object that can iterate through the name/value pairs in the query string.

An object that can iterate through the name/value pairs in the query string.

Represents a single name/value pair extracted from a query string during enumeration.

Gets the name from this name/value pair in its original encoded form. To get the decoded string, call .

Gets the value from this name/value pair in its original encoded form. To get the decoded string, call .

Decodes the name from this name/value pair.

Characters representing the decoded name.

Decodes the value from this name/value pair.

Characters representing the decoded value.

An enumerator that supplies the name/value pairs from a URI query string.

Gets the currently referenced key/value pair in the query string being enumerated.

Moves to the next key/value pair in the query string being enumerated.

True if there is another key/value pair, otherwise false.

Contains utility APIs to assist with common encoding and decoding operations.

Decodes a base64url-encoded string.

The base64url-encoded input to decode. The base64url-decoded form of the input. The input must not contain any whitespace or padding characters. Throws if the input is malformed.

Decodes a base64url-encoded substring of a given string.

A string containing the base64url-encoded input to decode. The position in at which decoding should begin. The number of characters in to decode. The base64url-decoded form of the input. The input must not contain any whitespace or padding characters. Throws if the input is malformed.

Decodes a base64url-encoded into a byte[].

A string containing the base64url-encoded input to decode. The position in at which decoding should begin. Scratch buffer to hold the s to decode. Array must be large enough to hold and characters as well as Base64 padding characters. Content is not preserved. The offset into at which to begin writing the s to decode. The number of characters in to decode. The base64url-decoded form of the . The input must not contain any whitespace or padding characters. Throws if the input is malformed.

Gets the minimum char[] size required for decoding of characters with the method.

The number of characters to decode. The minimum char[] size required for decoding of characters.

Encodes using base64url encoding.

The binary input to encode. The base64url-encoded form of .

Encodes using base64url encoding.

The binary input to encode. The offset into at which to begin encoding. The number of bytes from to encode. The base64url-encoded form of .

Encodes using base64url encoding.

The binary input to encode. The offset into at which to begin encoding. Buffer to receive the base64url-encoded form of . Array must be large enough to hold characters and the full base64-encoded form of , including padding characters. The offset into at which to begin writing the base64url-encoded form of . The number of bytes from to encode. The number of characters written to , less any padding characters.

Get the minimum output char[] size required for encoding s with the method.

The number of characters to encode. The minimum output char[] size required for encoding s.

Encodes using base64url encoding.

The binary input to encode. The base64url-encoded form of .

Form key length limit {0} or value length limit {1} exceeded.

Form key length limit {0} exceeded.

Form value length limit {0} exceeded.

The stream must support reading.

The stream must support writing.

Invalid {0}, {1} or {2} length.

Throws an if is null.

The reference type argument to validate as non-null. The name of the parameter with which corresponds.

Throws an if is zero.

The argument to validate as non-zero. The name of the parameter with which corresponds.

Throws an if is negative.

The argument to validate as non-negative. The name of the parameter with which corresponds.

Throws an if is negative.

The argument to validate as non-negative. The name of the parameter with which corresponds.

Throws an if is negative or zero.

The argument to validate as non-zero or non-negative. The name of the parameter with which corresponds.

Throws an if is greater than .

The argument to validate as less or equal than . The value to compare with . The name of the parameter with which corresponds.

Throws an if is greater than or equal .

The argument to validate as less than . The value to compare with . The name of the parameter with which corresponds.

Throws an if is less than .

The argument to validate as greatar than or equal than . The value to compare with . The name of the parameter with which corresponds.

Throws an if is less than or equal .

The argument to validate as greatar than than . The value to compare with . The name of the parameter with which corresponds.

Invalid {0}, {1} or {2} length.

Malformed input: {0} is an invalid input length.

Invalid {0}, {1} or {2} length.

Malformed input: {0} is an invalid input length.