update 20250326

This commit is contained in:
Stefan Hutter
2025-03-26 20:46:46 +01:00
parent c767e2ed82
commit e0d3dbbbff
460 changed files with 122504 additions and 1125 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.1 KiB

View File

@@ -66,37 +66,57 @@ shall not be used in advertising or otherwise to promote the sale,
use or other dealings in these Data Files or Software without prior
written authorization of the copyright holder.
License notice for Zlib
License notice for zlib-ng
-----------------------
https://github.com/madler/zlib
https://zlib.net/zlib_license.html
https://github.com/zlib-ng/zlib-ng/blob/d54e3769be0c522015b784eca2af258b1c026107/LICENSE.md
/* zlib.h -- interface of the 'zlib' general purpose compression library
version 1.2.13, October 13th, 2022
(C) 1995-2024 Jean-loup Gailly and Mark Adler
Copyright (C) 1995-2022 Jean-loup Gailly and Mark Adler
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
Jean-loup Gailly Mark Adler
jloup@gzip.org madler@alumni.caltech.edu
3. This notice may not be removed or altered from any source distribution.
*/
License notice for LinuxTracepoints
-----------------------------------
https://github.com/microsoft/LinuxTracepoints/blob/main/LICENSE
Copyright (c) Microsoft Corporation.
MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE
License notice for Mono
-------------------------------
@@ -480,8 +500,8 @@ Foundation, Inc., Hewlett-Packard Company, Microsoft, nor Digital
Equipment Corporation makes any representations about the
suitability of this software for any purpose."
License notice for The LLVM Compiler Infrastructure (Legacy License)
--------------------------------------------------------------------
License notice for The LLVM Compiler Infrastructure
---------------------------------------------------
Developed by:
@@ -986,8 +1006,8 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
License notice for The LLVM Project
-----------------------------------
License for remote stack unwind (https://github.com/llvm/llvm-project/blob/main/lldb/source/Symbol/CompactUnwindInfo.cpp)
--------------------------------------
Copyright 2019 LLVM Project
@@ -1270,3 +1290,107 @@ Licensed under the Apache License, Version 2.0.
Available at
https://github.com/SixLabors/ImageSharp/blob/f4f689ce67ecbcc35cebddba5aacb603e6d1068a/LICENSE
License for the Teddy multi-substring searching implementation
--------------------------------------
https://github.com/BurntSushi/aho-corasick
The MIT License (MIT)
Copyright (c) 2015 Andrew Gallant
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
License notice for Avx512Vbmi base64 encoding / decoding
--------------------------------------------------------
Copyright (c) 2015-2018, Wojciech Muła
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
--------------------------------------------------------
Aspects of base64 encoding / decoding are based on algorithm described in "Base64 encoding and decoding at almost the speed of a memory
copy", Wojciech Muła and Daniel Lemire. https://arxiv.org/pdf/1910.05109.pdf
License for FormatJS Intl.Segmenter grapheme segmentation algorithm
--------------------------------------------------------------------------
Available at https://github.com/formatjs/formatjs/blob/58d6a7b398d776ca3d2726d72ae1573b65cc3bef/packages/intl-segmenter/LICENSE.md
MIT License
Copyright (c) 2022 FormatJS
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
License for SharpFuzz and related samples
--------------------------------------
https://github.com/Metalnem/sharpfuzz
https://github.com/Metalnem/dotnet-fuzzers
https://github.com/Metalnem/libfuzzer-dotnet
MIT License
Copyright (c) 2018 Nemanja Mijailovic
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@@ -1,6 +1,6 @@
<Project InitialTargets="NETStandardCompatError_Microsoft_Bcl_AsyncInterfaces_net462">
<Target Name="NETStandardCompatError_Microsoft_Bcl_AsyncInterfaces_net462"
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
<Warning Text="Microsoft.Bcl.AsyncInterfaces 8.0.0 doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to net462 or later. You may also set &lt;SuppressTfmSupportBuildWarnings&gt;true&lt;/SuppressTfmSupportBuildWarnings&gt; in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
<Warning Text="Microsoft.Bcl.AsyncInterfaces 9.0.3 doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to net462 or later. You may also set &lt;SuppressTfmSupportBuildWarnings&gt;true&lt;/SuppressTfmSupportBuildWarnings&gt; in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
</Target>
</Project>

View File

@@ -0,0 +1,6 @@
<Project InitialTargets="NETStandardCompatError_Microsoft_Bcl_AsyncInterfaces_net8_0">
<Target Name="NETStandardCompatError_Microsoft_Bcl_AsyncInterfaces_net8_0"
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
<Warning Text="Microsoft.Bcl.AsyncInterfaces 9.0.3 doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to net8.0 or later. You may also set &lt;SuppressTfmSupportBuildWarnings&gt;true&lt;/SuppressTfmSupportBuildWarnings&gt; in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
</Target>
</Project>

View File

@@ -258,7 +258,7 @@
</member>
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
<summary>
Indicates the user is suppling a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
Indicates the user is supplying a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
</summary>
</member>
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
@@ -392,7 +392,7 @@
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
<summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
<param name="returnValue">
The return value condition. If the method returns this value, the associated parameter will not be null.
The return value condition. If the method returns this value, the associated field or property member will not be null.
</param>
<param name="member">
The field or property member that is promised to be not-null.
@@ -401,7 +401,7 @@
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
<summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
<param name="returnValue">
The return value condition. If the method returns this value, the associated parameter will not be null.
The return value condition. If the method returns this value, the associated field and property members will not be null.
</param>
<param name="members">
The list of field and property members that are promised to be not-null.

View File

@@ -258,7 +258,7 @@
</member>
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
<summary>
Indicates the user is suppling a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
Indicates the user is supplying a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
</summary>
</member>
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
@@ -392,7 +392,7 @@
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
<summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
<param name="returnValue">
The return value condition. If the method returns this value, the associated parameter will not be null.
The return value condition. If the method returns this value, the associated field or property member will not be null.
</param>
<param name="member">
The field or property member that is promised to be not-null.
@@ -401,7 +401,7 @@
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
<summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
<param name="returnValue">
The return value condition. If the method returns this value, the associated parameter will not be null.
The return value condition. If the method returns this value, the associated field and property members will not be null.
</param>
<param name="members">
The list of field and property members that are promised to be not-null.

View File

@@ -62,7 +62,7 @@
</member>
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
<summary>
Indicates the user is suppling a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
Indicates the user is supplying a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
</summary>
</member>
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
@@ -99,7 +99,7 @@
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
<summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
<param name="returnValue">
The return value condition. If the method returns this value, the associated parameter will not be null.
The return value condition. If the method returns this value, the associated field or property member will not be null.
</param>
<param name="member">
The field or property member that is promised to be not-null.
@@ -108,7 +108,7 @@
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
<summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
<param name="returnValue">
The return value condition. If the method returns this value, the associated parameter will not be null.
The return value condition. If the method returns this value, the associated field and property members will not be null.
</param>
<param name="members">
The list of field and property members that are promised to be not-null.

Binary file not shown.

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.1 KiB

View File

@@ -0,0 +1,49 @@
## About
<!-- A description of the package and where one can find more documentation -->
A library designed to make it easier to do high-performance I/O.
Apps that parse streaming data are composed of boilerplate code having many specialized and unusual code flows.
The boilerplate and special case code is complex and difficult to maintain.
`System.IO.Pipelines` was architected to:
* Have high performance parsing streaming data.
* Reduce code complexity.
## Key Features
<!-- The key features of this package -->
* Single producer/single consumer byte buffer management.
* Reduction in code complexity and boilerplate code associated with I/O operations.
## How to Use
<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
Check the [System.IO.Pipelines in .NET article](https://learn.microsoft.com/dotnet/standard/io/pipelines) for a full example.
## Main Types
<!-- The main types provided in this library -->
The main types provided by this library are:
* `System.IO.Pipelines.Pipe`
* `System.IO.Pipelines.PipeWriter`
* `System.IO.Pipelines.PipeReader`
## Additional Documentation
<!-- Links to further documentation. Remove conceptual documentation if not available for the library. -->
* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/io/pipelines)
* [API documentation](https://learn.microsoft.com/dotnet/api/system.io.pipelines)
## Feedback & Contributing
<!-- How to provide feedback on this package and contribute to it -->
System.IO.Pipelines is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime).

Binary file not shown.

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,6 @@
<Project InitialTargets="NETStandardCompatError_System_IO_Pipelines_net462">
<Target Name="NETStandardCompatError_System_IO_Pipelines_net462"
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
<Warning Text="System.IO.Pipelines 9.0.3 doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to net462 or later. You may also set &lt;SuppressTfmSupportBuildWarnings&gt;true&lt;/SuppressTfmSupportBuildWarnings&gt; in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
</Target>
</Project>

View File

@@ -0,0 +1,6 @@
<Project InitialTargets="NETStandardCompatError_System_IO_Pipelines_net8_0">
<Target Name="NETStandardCompatError_System_IO_Pipelines_net8_0"
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
<Warning Text="System.IO.Pipelines 9.0.3 doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to net8.0 or later. You may also set &lt;SuppressTfmSupportBuildWarnings&gt;true&lt;/SuppressTfmSupportBuildWarnings&gt; in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
</Target>
</Project>

View File

@@ -0,0 +1,391 @@
<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>System.IO.Pipelines</name>
</assembly>
<members>
<member name="T:System.IO.Pipelines.FlushResult">
<summary>Result returned by <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> call.</summary>
</member>
<member name="M:System.IO.Pipelines.FlushResult.#ctor(System.Boolean,System.Boolean)">
<summary>Initializes a new instance of <see cref="T:System.IO.Pipelines.FlushResult" /> struct setting the <see cref="P:System.IO.Pipelines.FlushResult.IsCanceled" /> and <see cref="P:System.IO.Pipelines.FlushResult.IsCompleted" /> flags.</summary>
<param name="isCanceled">
<see langword="true" /> to indicate the current <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> operation that produced this <see cref="T:System.IO.Pipelines.FlushResult" /> was canceled by <see cref="M:System.IO.Pipelines.PipeWriter.CancelPendingFlush" />; otherwise, <see langword="false" />.</param>
<param name="isCompleted">
<see langword="true" /> to indicate the reader is no longer reading data written to the <see cref="T:System.IO.Pipelines.PipeWriter" />.</param>
</member>
<member name="P:System.IO.Pipelines.FlushResult.IsCanceled">
<summary>Gets a value that indicates whether the current <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> operation was canceled by <see cref="M:System.IO.Pipelines.PipeWriter.CancelPendingFlush" />.</summary>
<returns>
<see langword="true" /> if the current <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> operation was canceled by <see cref="M:System.IO.Pipelines.PipeWriter.CancelPendingFlush" />; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.IO.Pipelines.FlushResult.IsCompleted">
<summary>Gets a value that indicates the reader is no longer reading data written to the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
<returns>
<see langword="true" /> if the reader is no longer reading data written to the <see cref="T:System.IO.Pipelines.PipeWriter" />; otherwise, <see langword="false" />.</returns>
</member>
<member name="T:System.IO.Pipelines.IDuplexPipe">
<summary>Defines a class that provides a duplex pipe from which data can be read from and written to.</summary>
</member>
<member name="P:System.IO.Pipelines.IDuplexPipe.Input">
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeReader" /> half of the duplex pipe.</summary>
</member>
<member name="P:System.IO.Pipelines.IDuplexPipe.Output">
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeWriter" /> half of the duplex pipe.</summary>
</member>
<member name="T:System.IO.Pipelines.Pipe">
<summary>The default <see cref="T:System.IO.Pipelines.PipeWriter" /> and <see cref="T:System.IO.Pipelines.PipeReader" /> implementation.</summary>
</member>
<member name="M:System.IO.Pipelines.Pipe.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.IO.Pipelines.Pipe" /> class using <see cref="P:System.IO.Pipelines.PipeOptions.Default" /> as options.</summary>
</member>
<member name="M:System.IO.Pipelines.Pipe.#ctor(System.IO.Pipelines.PipeOptions)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Pipelines.Pipe" /> class with the specified options.</summary>
<param name="options">The set of options for this pipe.</param>
</member>
<member name="M:System.IO.Pipelines.Pipe.Reset">
<summary>Resets the pipe.</summary>
</member>
<member name="P:System.IO.Pipelines.Pipe.Reader">
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeReader" /> for this pipe.</summary>
<returns>A <see cref="T:System.IO.Pipelines.PipeReader" /> instance for this pipe.</returns>
</member>
<member name="P:System.IO.Pipelines.Pipe.Writer">
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeWriter" /> for this pipe.</summary>
<returns>A <see cref="T:System.IO.Pipelines.PipeWriter" /> instance for this pipe.</returns>
</member>
<member name="T:System.IO.Pipelines.PipeOptions">
<summary>Represents a set of <see cref="T:System.IO.Pipelines.Pipe" /> options.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.IO.Pipelines.PipeScheduler,System.IO.Pipelines.PipeScheduler,System.Int64,System.Int64,System.Int32,System.Boolean)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Pipelines.PipeOptions" /> class with the specified parameters.</summary>
<param name="pool">The pool of memory blocks to be used for buffer management.</param>
<param name="readerScheduler">The <see cref="T:System.IO.Pipelines.PipeScheduler" /> to be used to execute <see cref="T:System.IO.Pipelines.PipeReader" /> callbacks and async continuations.</param>
<param name="writerScheduler">The <see cref="T:System.IO.Pipelines.PipeScheduler" /> used to execute <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks and async continuations.</param>
<param name="pauseWriterThreshold">The number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> before <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> starts blocking. A value of zero prevents <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> from ever blocking, effectively making the number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> unlimited.</param>
<param name="resumeWriterThreshold">The number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> stops blocking.</param>
<param name="minimumSegmentSize">The minimum size of the segment requested from <paramref name="pool" />.</param>
<param name="useSynchronizationContext">
<see langword="true" /> if asynchronous continuations should be executed on the <see cref="T:System.Threading.SynchronizationContext" /> they were captured on; <see langword="false" /> otherwise. This takes precedence over the schedulers specified in <see cref="P:System.IO.Pipelines.PipeOptions.ReaderScheduler" /> and <see cref="P:System.IO.Pipelines.PipeOptions.WriterScheduler" />.</param>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.Default">
<summary>Gets the default instance of <see cref="T:System.IO.Pipelines.PipeOptions" />.</summary>
<returns>A <see cref="T:System.IO.Pipelines.PipeOptions" /> object initialized with default parameters.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.MinimumSegmentSize">
<summary>Gets the minimum size of the segment requested from the <see cref="P:System.IO.Pipelines.PipeOptions.Pool" />.</summary>
<returns>The minimum size of the segment requested from the <see cref="P:System.IO.Pipelines.PipeOptions.Pool" />.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.PauseWriterThreshold">
<summary>Gets the number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> starts blocking. A value of zero prevents <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> from ever blocking, effectively making the number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> unlimited.</summary>
<returns>The number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> starts blocking.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.Pool">
<summary>Gets the <see cref="T:System.Buffers.MemoryPool`1" /> object used for buffer management.</summary>
<returns>A pool of memory blocks used for buffer management.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.ReaderScheduler">
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeScheduler" /> used to execute <see cref="T:System.IO.Pipelines.PipeReader" /> callbacks and async continuations.</summary>
<returns>A <see cref="T:System.IO.Pipelines.PipeScheduler" /> that is used to execute <see cref="T:System.IO.Pipelines.PipeReader" /> callbacks and async continuations.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.ResumeWriterThreshold">
<summary>Gets the number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> stops blocking.</summary>
<returns>The number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> stops blocking.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.UseSynchronizationContext">
<summary>Gets a value that determines if asynchronous callbacks and continuations should be executed on the <see cref="T:System.Threading.SynchronizationContext" /> they were captured on. This takes precedence over the schedulers specified in <see cref="P:System.IO.Pipelines.PipeOptions.ReaderScheduler" /> and <see cref="P:System.IO.Pipelines.PipeOptions.WriterScheduler" />.</summary>
<returns>
<see langword="true" /> if asynchronous callbacks and continuations should be executed on the <see cref="T:System.Threading.SynchronizationContext" /> they were captured on; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.WriterScheduler">
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeScheduler" /> used to execute <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks and async continuations.</summary>
<returns>A <see cref="T:System.IO.Pipelines.PipeScheduler" /> object used to execute <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks and async continuations.</returns>
</member>
<member name="T:System.IO.Pipelines.PipeReader">
<summary>Defines a class that provides access to a read side of pipe.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeReader.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.IO.Pipelines.PipeReader" /> class.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeReader.AdvanceTo(System.SequencePosition,System.SequencePosition)">
<summary>Moves forward the pipeline's read cursor to after the consumed data, marking the data as processed, read and examined.</summary>
<param name="consumed">Marks the extent of the data that has been successfully processed.</param>
<param name="examined">Marks the extent of the data that has been read and examined.</param>
</member>
<member name="M:System.IO.Pipelines.PipeReader.AdvanceTo(System.SequencePosition)">
<summary>Moves forward the pipeline's read cursor to after the consumed data, marking the data as processed.</summary>
<param name="consumed">Marks the extent of the data that has been successfully processed.</param>
</member>
<member name="M:System.IO.Pipelines.PipeReader.AsStream(System.Boolean)">
<summary>Returns a <see cref="T:System.IO.Stream" /> representation of the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
<param name="leaveOpen">An optional flag that indicates whether disposing the returned <see cref="T:System.IO.Stream" /> leaves <see cref="T:System.IO.Pipelines.PipeReader" /> open (<see langword="true" />) or completes <see cref="T:System.IO.Pipelines.PipeReader" /> (<see langword="false" />).</param>
<returns>A stream that represents the <see cref="T:System.IO.Pipelines.PipeReader" />.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.CancelPendingRead">
<summary>Cancels the pending <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> operation without causing it to throw and without completing the <see cref="T:System.IO.Pipelines.PipeReader" />. If there is no pending operation, this cancels the next operation.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeReader.Complete(System.Exception)">
<summary>Signals to the producer that the consumer is done reading.</summary>
<param name="exception">Optional <see cref="T:System.Exception" /> indicating a failure that's causing the pipeline to complete.</param>
</member>
<member name="M:System.IO.Pipelines.PipeReader.CompleteAsync(System.Exception)">
<summary>Marks the current pipe reader instance as being complete, meaning no more data will be read from it.</summary>
<param name="exception">An optional exception that indicates the failure that caused the reader to complete.</param>
<returns>A value task that represents the asynchronous complete operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.CopyToAsync(System.IO.Pipelines.PipeWriter,System.Threading.CancellationToken)">
<summary>Asynchronously reads the bytes from the <see cref="T:System.IO.Pipelines.PipeReader" /> and writes them to the specified <see cref="T:System.IO.Pipelines.PipeWriter" />, using a specified cancellation token.</summary>
<param name="destination">The pipe writer to which the contents of the current stream will be copied.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A task that represents the asynchronous copy operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.CopyToAsync(System.IO.Stream,System.Threading.CancellationToken)">
<summary>Asynchronously reads the bytes from the <see cref="T:System.IO.Pipelines.PipeReader" /> and writes them to the specified stream, using a specified cancellation token.</summary>
<param name="destination">The stream to which the contents of the current stream will be copied.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A task that represents the asynchronous copy operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.Create(System.Buffers.ReadOnlySequence{System.Byte})">
<summary>Creates a <see cref="T:System.IO.Pipelines.PipeReader" /> wrapping the specified <see cref="T:System.Buffers.ReadOnlySequence`1" />.</summary>
<param name="sequence">The sequence to wrap.</param>
<returns>A <see cref="T:System.IO.Pipelines.PipeReader" /> that wraps the <see cref="T:System.Buffers.ReadOnlySequence`1" />.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.Create(System.IO.Stream,System.IO.Pipelines.StreamPipeReaderOptions)">
<summary>Creates a <see cref="T:System.IO.Pipelines.PipeReader" /> wrapping the specified <see cref="T:System.IO.Stream" />.</summary>
<param name="stream">The stream that the pipe reader will wrap.</param>
<param name="readerOptions">The options to configure the pipe reader.</param>
<returns>A <see cref="T:System.IO.Pipelines.PipeReader" /> that wraps the <see cref="T:System.IO.Stream" />.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.OnWriterCompleted(System.Action{System.Exception,System.Object},System.Object)">
<summary>Registers a callback that executes when the <see cref="T:System.IO.Pipelines.PipeWriter" /> side of the pipe is completed.</summary>
<param name="callback">The callback to register.</param>
<param name="state">The state object to pass to <paramref name="callback" /> when it's invoked.</param>
</member>
<member name="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)">
<summary>Asynchronously reads a sequence of bytes from the current <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see langword="default" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A <see cref="T:System.Threading.Tasks.ValueTask`1" /> representing the asynchronous read operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.ReadAtLeastAsync(System.Int32,System.Threading.CancellationToken)">
<summary>Asynchronously reads a sequence of bytes from the current <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
<param name="minimumSize">The minimum length that needs to be buffered in order for the call to return.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see langword="default" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A <see cref="T:System.Threading.Tasks.ValueTask`1" /> representing the asynchronous read operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.ReadAtLeastAsyncCore(System.Int32,System.Threading.CancellationToken)">
<summary>Asynchronously reads a sequence of bytes from the current <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
<param name="minimumSize">The minimum length that needs to be buffered in order for the call to return.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see langword="default" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A <see cref="T:System.Threading.Tasks.ValueTask`1" /> representing the asynchronous read operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.TryRead(System.IO.Pipelines.ReadResult@)">
<summary>Attempts to synchronously read data the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
<param name="result">When this method returns <see langword="true" />, this value is set to a <see cref="T:System.IO.Pipelines.ReadResult" /> instance that represents the result of the read call; otherwise, this value is set to <see langword="default" />.</param>
<returns>
<see langword="true" /> if data was available, or if the call was canceled or the writer was completed; otherwise, <see langword="false" />.</returns>
</member>
<member name="T:System.IO.Pipelines.PipeScheduler">
<summary>Abstraction for running <see cref="T:System.IO.Pipelines.PipeReader" /> and <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks and continuations.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeScheduler.#ctor">
<summary>Initializes new a <see cref="T:System.IO.Pipelines.PipeScheduler" /> instance.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeScheduler.Schedule(System.Action{System.Object},System.Object)">
<summary>Requests <paramref name="action" /> to be run on scheduler with <paramref name="state" /> being passed in.</summary>
<param name="action">The single-parameter action delegate to schedule.</param>
<param name="state">The parameter to pass to the <paramref name="action" /> delegate.</param>
</member>
<member name="P:System.IO.Pipelines.PipeScheduler.Inline">
<summary>The <see cref="T:System.IO.Pipelines.PipeScheduler" /> implementation that runs callbacks inline.</summary>
<returns>A <see cref="T:System.IO.Pipelines.PipeScheduler" /> instance that runs callbacks inline.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeScheduler.ThreadPool">
<summary>The <see cref="T:System.IO.Pipelines.PipeScheduler" /> implementation that queues callbacks to the thread pool.</summary>
<returns>A <see cref="T:System.IO.Pipelines.PipeScheduler" /> instance that queues callbacks to the thread pool.</returns>
</member>
<member name="T:System.IO.Pipelines.PipeWriter">
<summary>Defines a class that provides a pipeline to which data can be written.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.#ctor">
<summary>Initializes a new instance of the class.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.Advance(System.Int32)">
<summary>Notifies the <see cref="T:System.IO.Pipelines.PipeWriter" /> that <paramref name="bytes" /> bytes were written to the output <see cref="T:System.Span`1" /> or <see cref="T:System.Memory`1" />. You must call <see cref="M:System.IO.Pipelines.PipeWriter.GetSpan(System.Int32)" /> or <see cref="M:System.IO.Pipelines.PipeWriter.GetMemory(System.Int32)" /> again and use the returned buffer to continue writing more data after calling <see cref="M:System.IO.Pipelines.PipeWriter.Advance(System.Int32)" />; you cannot write to a previously acquired buffer.</summary>
<param name="bytes">The number of bytes written to the <see cref="T:System.Span`1" /> or <see cref="T:System.Memory`1" />.</param>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.AsStream(System.Boolean)">
<summary>Returns a <see cref="T:System.IO.Stream" /> representation of the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
<param name="leaveOpen">An optional flag that indicates whether disposing the returned <see cref="T:System.IO.Stream" /> leaves <see cref="T:System.IO.Pipelines.PipeReader" /> open (<see langword="true" />) or completes <see cref="T:System.IO.Pipelines.PipeReader" /> (<see langword="false" />).</param>
<returns>A stream that represents the <see cref="T:System.IO.Pipelines.PipeWriter" />.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.CancelPendingFlush">
<summary>Cancels the pending <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> or <see cref="M:System.IO.Pipelines.PipeWriter.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)" /> operation without causing the operation to throw and without completing the <see cref="T:System.IO.Pipelines.PipeWriter" />. If there is no pending operation, this cancels the next operation.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.Complete(System.Exception)">
<summary>Marks the <see cref="T:System.IO.Pipelines.PipeWriter" /> as being complete, meaning no more items will be written to it.</summary>
<param name="exception">Optional <see cref="T:System.Exception" /> indicating a failure that's causing the pipeline to complete.</param>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.CompleteAsync(System.Exception)">
<summary>Marks the current pipe writer instance as being complete, meaning no more data will be written to it.</summary>
<param name="exception">An optional exception that indicates the failure that caused the pipeline to complete.</param>
<returns>A value task that represents the asynchronous complete operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.CopyFromAsync(System.IO.Stream,System.Threading.CancellationToken)">
<summary>Asynchronously reads the bytes from the specified stream and writes them to the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
<param name="source">The stream from which the contents will be copied.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A task that represents the asynchronous copy operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.Create(System.IO.Stream,System.IO.Pipelines.StreamPipeWriterOptions)">
<summary>Creates a <see cref="T:System.IO.Pipelines.PipeWriter" /> wrapping the specified <see cref="T:System.IO.Stream" />.</summary>
<param name="stream">The stream that the pipe writer will wrap.</param>
<param name="writerOptions">The options to configure the pipe writer.</param>
<returns>A <see cref="T:System.IO.Pipelines.PipeWriter" /> that wraps the <see cref="T:System.IO.Stream" />.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)">
<summary>Makes bytes written available to <see cref="T:System.IO.Pipelines.PipeReader" /> and runs <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> continuation.</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A task that represents and wraps the asynchronous flush operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.GetMemory(System.Int32)">
<summary>Returns a <see cref="T:System.Memory`1" /> to write to that is at least the requested size, as specified by the <paramref name="sizeHint" /> parameter.</summary>
<param name="sizeHint">The minimum length of the returned <see cref="T:System.Memory`1" />. If 0, a non-empty memory buffer of arbitrary size is returned.</param>
<exception cref="T:System.OutOfMemoryException">The requested buffer size is not available.</exception>
<returns>A memory buffer of at least <paramref name="sizeHint" /> bytes. If <paramref name="sizeHint" /> is 0, returns a non-empty buffer of arbitrary size.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.GetSpan(System.Int32)">
<summary>Returns a <see cref="T:System.Span`1" /> to write to that is at least the requested size, as specified by the <paramref name="sizeHint" /> parameter.</summary>
<param name="sizeHint">The minimum length of the returned <see cref="T:System.Span`1" />. If 0, a non-empty buffer of arbitrary size is returned.</param>
<exception cref="T:System.OutOfMemoryException">The requested buffer size is not available.</exception>
<returns>A buffer of at least <paramref name="sizeHint" /> bytes. If <paramref name="sizeHint" /> is 0, returns a non-empty buffer of arbitrary size.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.OnReaderCompleted(System.Action{System.Exception,System.Object},System.Object)">
<summary>Registers a callback that executes when the <see cref="T:System.IO.Pipelines.PipeReader" /> side of the pipe is completed.</summary>
<param name="callback">The callback to register.</param>
<param name="state">The state object to pass to <paramref name="callback" /> when it's invoked.</param>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)">
<summary>Writes the specified byte memory range to the pipe and makes data accessible to the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
<param name="source">The read-only byte memory region to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A task that represents the asynchronous write operation, and wraps the flush asynchronous operation.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeWriter.CanGetUnflushedBytes">
<summary>Gets a value that indicates whether the current <see cref="T:System.IO.Pipelines.PipeWriter" /> supports reporting the count of unflushed bytes.</summary>
<returns>
<see langword="true" />If a class derived from <see cref="T:System.IO.Pipelines.PipeWriter" /> does not support getting the unflushed bytes, calls to <see cref="P:System.IO.Pipelines.PipeWriter.UnflushedBytes" /> throw <see cref="T:System.NotImplementedException" />.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeWriter.UnflushedBytes">
<summary>When overridden in a derived class, gets the count of unflushed bytes within the current writer.</summary>
<exception cref="T:System.NotImplementedException">The <see cref="T:System.IO.Pipelines.PipeWriter" /> does not support getting the unflushed byte count.</exception>
</member>
<member name="T:System.IO.Pipelines.ReadResult">
<summary>Represents the result of a <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> call.</summary>
</member>
<member name="M:System.IO.Pipelines.ReadResult.#ctor(System.Buffers.ReadOnlySequence{System.Byte},System.Boolean,System.Boolean)">
<summary>Creates a new instance of <see cref="T:System.IO.Pipelines.ReadResult" /> setting <see cref="P:System.IO.Pipelines.ReadResult.IsCanceled" /> and <see cref="P:System.IO.Pipelines.ReadResult.IsCompleted" /> flags.</summary>
<param name="buffer">The read-only sequence containing the bytes of data that were read in the <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> call.</param>
<param name="isCanceled">A flag that indicates if the <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> operation that produced this <see cref="T:System.IO.Pipelines.ReadResult" /> was canceled by <see cref="M:System.IO.Pipelines.PipeReader.CancelPendingRead" />.</param>
<param name="isCompleted">A flag that indicates whether the end of the data stream has been reached.</param>
</member>
<member name="P:System.IO.Pipelines.ReadResult.Buffer">
<summary>Gets the <see cref="T:System.Buffers.ReadOnlySequence`1" /> that was read.</summary>
<returns>A read-only sequence containing the bytes of data that were read in the <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> call.</returns>
</member>
<member name="P:System.IO.Pipelines.ReadResult.IsCanceled">
<summary>Gets a value that indicates whether the current <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> operation was canceled by <see cref="M:System.IO.Pipelines.PipeReader.CancelPendingRead" />.</summary>
<returns>
<see langword="true" /> if the <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> operation that produced this <see cref="T:System.IO.Pipelines.ReadResult" /> was canceled by <see cref="M:System.IO.Pipelines.PipeReader.CancelPendingRead" />; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.IO.Pipelines.ReadResult.IsCompleted">
<summary>Gets a value that indicates whether the end of the data stream has been reached.</summary>
<returns>
<see langword="true" /> if the end of the data stream has been reached; otherwise, <see langword="false" />.</returns>
</member>
<member name="T:System.IO.Pipelines.StreamPipeExtensions">
<summary>Provides extension methods for <see cref="T:System.IO.Stream" /> that support read and write operations directly into pipes.</summary>
</member>
<member name="M:System.IO.Pipelines.StreamPipeExtensions.CopyToAsync(System.IO.Stream,System.IO.Pipelines.PipeWriter,System.Threading.CancellationToken)">
<summary>Asynchronously reads the bytes from the <see cref="T:System.IO.Stream" /> and writes them to the specified <see cref="T:System.IO.Pipelines.PipeWriter" />, using a cancellation token.</summary>
<param name="source">The stream from which the contents of the current stream will be copied.</param>
<param name="destination">The writer to which the contents of the source stream will be copied.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A task that represents the asynchronous copy operation.</returns>
</member>
<member name="T:System.IO.Pipelines.StreamPipeReaderOptions">
<summary>Represents a set of options for controlling the creation of the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
</member>
<member name="M:System.IO.Pipelines.StreamPipeReaderOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.Int32,System.Int32,System.Boolean,System.Boolean)">
<summary>Initializes a <see cref="T:System.IO.Pipelines.StreamPipeReaderOptions" /> instance, optionally specifying a memory pool, a minimum buffer size, a minimum read size, and whether the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes.</summary>
<param name="pool">The memory pool to use when allocating memory. The default value is <see langword="null" />.</param>
<param name="bufferSize">The minimum buffer size to use when renting memory from the <paramref name="pool" />. The default value is 4096.</param>
<param name="minimumReadSize">The threshold of remaining bytes in the buffer before a new buffer is allocated. The default value is 1024.</param>
<param name="leaveOpen">
<see langword="true" /> to leave the underlying stream open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes; <see langword="false" /> to close it. The default is <see langword="false" />.</param>
<param name="useZeroByteReads">
<see langword="true" /> if reads with an empty buffer should be issued to the underlying stream before allocating memory; otherwise, <see langword="false" />.</param>
</member>
<member name="M:System.IO.Pipelines.StreamPipeReaderOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.Int32,System.Int32,System.Boolean)">
<summary>Initializes a <see cref="T:System.IO.Pipelines.StreamPipeReaderOptions" /> instance, optionally specifying a memory pool, a minimum buffer size, a minimum read size, and whether the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes.</summary>
<param name="pool">The memory pool to use when allocating memory. The default value is <see langword="null" />.</param>
<param name="bufferSize">The minimum buffer size to use when renting memory from the <paramref name="pool" />. The default value is 4096.</param>
<param name="minimumReadSize">The threshold of remaining bytes in the buffer before a new buffer is allocated. The default value is 1024.</param>
<param name="leaveOpen">
<see langword="true" /> to leave the underlying stream open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes; <see langword="false" /> to close it. The default is <see langword="false" />.</param>
</member>
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.BufferSize">
<summary>Gets the minimum buffer size to use when renting memory from the <see cref="P:System.IO.Pipelines.StreamPipeReaderOptions.Pool" />.</summary>
<returns>The buffer size.</returns>
</member>
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.LeaveOpen">
<summary>Gets the value that indicates if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes.</summary>
<returns>
<see langword="true" /> if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.MinimumReadSize">
<summary>Gets the threshold of remaining bytes in the buffer before a new buffer is allocated.</summary>
<returns>The minimum read size.</returns>
</member>
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.Pool">
<summary>Gets the <see cref="T:System.Buffers.MemoryPool`1" /> to use when allocating memory.</summary>
<returns>A memory pool instance.</returns>
</member>
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.UseZeroByteReads">
<summary>Gets the value that indicates if reads with an empty buffer should be issued to the underlying stream, in order to wait for data to arrive before allocating memory.</summary>
<returns>
<see langword="true" /> if reads with an empty buffer should be issued to the underlying stream before allocating memory; otherwise, <see langword="false" />.</returns>
</member>
<member name="T:System.IO.Pipelines.StreamPipeWriterOptions">
<summary>Represents a set of options for controlling the creation of the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
</member>
<member name="M:System.IO.Pipelines.StreamPipeWriterOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.Int32,System.Boolean)">
<summary>Initializes a <see cref="T:System.IO.Pipelines.StreamPipeWriterOptions" /> instance, optionally specifying a memory pool, a minimum buffer size, and whether the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes.</summary>
<param name="pool">The memory pool to use when allocating memory. The default value is <see langword="null" />.</param>
<param name="minimumBufferSize">The minimum buffer size to use when renting memory from the <paramref name="pool" />. The default value is 4096.</param>
<param name="leaveOpen">
<see langword="true" /> to leave the underlying stream open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes; <see langword="false" /> to close it. The default is <see langword="false" />.</param>
</member>
<member name="P:System.IO.Pipelines.StreamPipeWriterOptions.LeaveOpen">
<summary>Gets the value that indicates if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes.</summary>
<returns>
<see langword="true" /> if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.IO.Pipelines.StreamPipeWriterOptions.MinimumBufferSize">
<summary>Gets the minimum buffer size to use when renting memory from the <see cref="P:System.IO.Pipelines.StreamPipeWriterOptions.Pool" />.</summary>
<returns>An integer representing the minimum buffer size.</returns>
</member>
<member name="P:System.IO.Pipelines.StreamPipeWriterOptions.Pool">
<summary>Gets the <see cref="T:System.Buffers.MemoryPool`1" /> to use when allocating memory.</summary>
<returns>A memory pool instance.</returns>
</member>
</members>
</doc>

View File

@@ -0,0 +1,391 @@
<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>System.IO.Pipelines</name>
</assembly>
<members>
<member name="T:System.IO.Pipelines.FlushResult">
<summary>Result returned by <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> call.</summary>
</member>
<member name="M:System.IO.Pipelines.FlushResult.#ctor(System.Boolean,System.Boolean)">
<summary>Initializes a new instance of <see cref="T:System.IO.Pipelines.FlushResult" /> struct setting the <see cref="P:System.IO.Pipelines.FlushResult.IsCanceled" /> and <see cref="P:System.IO.Pipelines.FlushResult.IsCompleted" /> flags.</summary>
<param name="isCanceled">
<see langword="true" /> to indicate the current <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> operation that produced this <see cref="T:System.IO.Pipelines.FlushResult" /> was canceled by <see cref="M:System.IO.Pipelines.PipeWriter.CancelPendingFlush" />; otherwise, <see langword="false" />.</param>
<param name="isCompleted">
<see langword="true" /> to indicate the reader is no longer reading data written to the <see cref="T:System.IO.Pipelines.PipeWriter" />.</param>
</member>
<member name="P:System.IO.Pipelines.FlushResult.IsCanceled">
<summary>Gets a value that indicates whether the current <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> operation was canceled by <see cref="M:System.IO.Pipelines.PipeWriter.CancelPendingFlush" />.</summary>
<returns>
<see langword="true" /> if the current <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> operation was canceled by <see cref="M:System.IO.Pipelines.PipeWriter.CancelPendingFlush" />; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.IO.Pipelines.FlushResult.IsCompleted">
<summary>Gets a value that indicates the reader is no longer reading data written to the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
<returns>
<see langword="true" /> if the reader is no longer reading data written to the <see cref="T:System.IO.Pipelines.PipeWriter" />; otherwise, <see langword="false" />.</returns>
</member>
<member name="T:System.IO.Pipelines.IDuplexPipe">
<summary>Defines a class that provides a duplex pipe from which data can be read from and written to.</summary>
</member>
<member name="P:System.IO.Pipelines.IDuplexPipe.Input">
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeReader" /> half of the duplex pipe.</summary>
</member>
<member name="P:System.IO.Pipelines.IDuplexPipe.Output">
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeWriter" /> half of the duplex pipe.</summary>
</member>
<member name="T:System.IO.Pipelines.Pipe">
<summary>The default <see cref="T:System.IO.Pipelines.PipeWriter" /> and <see cref="T:System.IO.Pipelines.PipeReader" /> implementation.</summary>
</member>
<member name="M:System.IO.Pipelines.Pipe.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.IO.Pipelines.Pipe" /> class using <see cref="P:System.IO.Pipelines.PipeOptions.Default" /> as options.</summary>
</member>
<member name="M:System.IO.Pipelines.Pipe.#ctor(System.IO.Pipelines.PipeOptions)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Pipelines.Pipe" /> class with the specified options.</summary>
<param name="options">The set of options for this pipe.</param>
</member>
<member name="M:System.IO.Pipelines.Pipe.Reset">
<summary>Resets the pipe.</summary>
</member>
<member name="P:System.IO.Pipelines.Pipe.Reader">
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeReader" /> for this pipe.</summary>
<returns>A <see cref="T:System.IO.Pipelines.PipeReader" /> instance for this pipe.</returns>
</member>
<member name="P:System.IO.Pipelines.Pipe.Writer">
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeWriter" /> for this pipe.</summary>
<returns>A <see cref="T:System.IO.Pipelines.PipeWriter" /> instance for this pipe.</returns>
</member>
<member name="T:System.IO.Pipelines.PipeOptions">
<summary>Represents a set of <see cref="T:System.IO.Pipelines.Pipe" /> options.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.IO.Pipelines.PipeScheduler,System.IO.Pipelines.PipeScheduler,System.Int64,System.Int64,System.Int32,System.Boolean)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Pipelines.PipeOptions" /> class with the specified parameters.</summary>
<param name="pool">The pool of memory blocks to be used for buffer management.</param>
<param name="readerScheduler">The <see cref="T:System.IO.Pipelines.PipeScheduler" /> to be used to execute <see cref="T:System.IO.Pipelines.PipeReader" /> callbacks and async continuations.</param>
<param name="writerScheduler">The <see cref="T:System.IO.Pipelines.PipeScheduler" /> used to execute <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks and async continuations.</param>
<param name="pauseWriterThreshold">The number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> before <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> starts blocking. A value of zero prevents <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> from ever blocking, effectively making the number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> unlimited.</param>
<param name="resumeWriterThreshold">The number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> stops blocking.</param>
<param name="minimumSegmentSize">The minimum size of the segment requested from <paramref name="pool" />.</param>
<param name="useSynchronizationContext">
<see langword="true" /> if asynchronous continuations should be executed on the <see cref="T:System.Threading.SynchronizationContext" /> they were captured on; <see langword="false" /> otherwise. This takes precedence over the schedulers specified in <see cref="P:System.IO.Pipelines.PipeOptions.ReaderScheduler" /> and <see cref="P:System.IO.Pipelines.PipeOptions.WriterScheduler" />.</param>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.Default">
<summary>Gets the default instance of <see cref="T:System.IO.Pipelines.PipeOptions" />.</summary>
<returns>A <see cref="T:System.IO.Pipelines.PipeOptions" /> object initialized with default parameters.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.MinimumSegmentSize">
<summary>Gets the minimum size of the segment requested from the <see cref="P:System.IO.Pipelines.PipeOptions.Pool" />.</summary>
<returns>The minimum size of the segment requested from the <see cref="P:System.IO.Pipelines.PipeOptions.Pool" />.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.PauseWriterThreshold">
<summary>Gets the number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> starts blocking. A value of zero prevents <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> from ever blocking, effectively making the number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> unlimited.</summary>
<returns>The number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> starts blocking.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.Pool">
<summary>Gets the <see cref="T:System.Buffers.MemoryPool`1" /> object used for buffer management.</summary>
<returns>A pool of memory blocks used for buffer management.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.ReaderScheduler">
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeScheduler" /> used to execute <see cref="T:System.IO.Pipelines.PipeReader" /> callbacks and async continuations.</summary>
<returns>A <see cref="T:System.IO.Pipelines.PipeScheduler" /> that is used to execute <see cref="T:System.IO.Pipelines.PipeReader" /> callbacks and async continuations.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.ResumeWriterThreshold">
<summary>Gets the number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> stops blocking.</summary>
<returns>The number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> stops blocking.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.UseSynchronizationContext">
<summary>Gets a value that determines if asynchronous callbacks and continuations should be executed on the <see cref="T:System.Threading.SynchronizationContext" /> they were captured on. This takes precedence over the schedulers specified in <see cref="P:System.IO.Pipelines.PipeOptions.ReaderScheduler" /> and <see cref="P:System.IO.Pipelines.PipeOptions.WriterScheduler" />.</summary>
<returns>
<see langword="true" /> if asynchronous callbacks and continuations should be executed on the <see cref="T:System.Threading.SynchronizationContext" /> they were captured on; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.WriterScheduler">
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeScheduler" /> used to execute <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks and async continuations.</summary>
<returns>A <see cref="T:System.IO.Pipelines.PipeScheduler" /> object used to execute <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks and async continuations.</returns>
</member>
<member name="T:System.IO.Pipelines.PipeReader">
<summary>Defines a class that provides access to a read side of pipe.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeReader.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.IO.Pipelines.PipeReader" /> class.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeReader.AdvanceTo(System.SequencePosition,System.SequencePosition)">
<summary>Moves forward the pipeline's read cursor to after the consumed data, marking the data as processed, read and examined.</summary>
<param name="consumed">Marks the extent of the data that has been successfully processed.</param>
<param name="examined">Marks the extent of the data that has been read and examined.</param>
</member>
<member name="M:System.IO.Pipelines.PipeReader.AdvanceTo(System.SequencePosition)">
<summary>Moves forward the pipeline's read cursor to after the consumed data, marking the data as processed.</summary>
<param name="consumed">Marks the extent of the data that has been successfully processed.</param>
</member>
<member name="M:System.IO.Pipelines.PipeReader.AsStream(System.Boolean)">
<summary>Returns a <see cref="T:System.IO.Stream" /> representation of the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
<param name="leaveOpen">An optional flag that indicates whether disposing the returned <see cref="T:System.IO.Stream" /> leaves <see cref="T:System.IO.Pipelines.PipeReader" /> open (<see langword="true" />) or completes <see cref="T:System.IO.Pipelines.PipeReader" /> (<see langword="false" />).</param>
<returns>A stream that represents the <see cref="T:System.IO.Pipelines.PipeReader" />.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.CancelPendingRead">
<summary>Cancels the pending <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> operation without causing it to throw and without completing the <see cref="T:System.IO.Pipelines.PipeReader" />. If there is no pending operation, this cancels the next operation.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeReader.Complete(System.Exception)">
<summary>Signals to the producer that the consumer is done reading.</summary>
<param name="exception">Optional <see cref="T:System.Exception" /> indicating a failure that's causing the pipeline to complete.</param>
</member>
<member name="M:System.IO.Pipelines.PipeReader.CompleteAsync(System.Exception)">
<summary>Marks the current pipe reader instance as being complete, meaning no more data will be read from it.</summary>
<param name="exception">An optional exception that indicates the failure that caused the reader to complete.</param>
<returns>A value task that represents the asynchronous complete operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.CopyToAsync(System.IO.Pipelines.PipeWriter,System.Threading.CancellationToken)">
<summary>Asynchronously reads the bytes from the <see cref="T:System.IO.Pipelines.PipeReader" /> and writes them to the specified <see cref="T:System.IO.Pipelines.PipeWriter" />, using a specified cancellation token.</summary>
<param name="destination">The pipe writer to which the contents of the current stream will be copied.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A task that represents the asynchronous copy operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.CopyToAsync(System.IO.Stream,System.Threading.CancellationToken)">
<summary>Asynchronously reads the bytes from the <see cref="T:System.IO.Pipelines.PipeReader" /> and writes them to the specified stream, using a specified cancellation token.</summary>
<param name="destination">The stream to which the contents of the current stream will be copied.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A task that represents the asynchronous copy operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.Create(System.Buffers.ReadOnlySequence{System.Byte})">
<summary>Creates a <see cref="T:System.IO.Pipelines.PipeReader" /> wrapping the specified <see cref="T:System.Buffers.ReadOnlySequence`1" />.</summary>
<param name="sequence">The sequence to wrap.</param>
<returns>A <see cref="T:System.IO.Pipelines.PipeReader" /> that wraps the <see cref="T:System.Buffers.ReadOnlySequence`1" />.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.Create(System.IO.Stream,System.IO.Pipelines.StreamPipeReaderOptions)">
<summary>Creates a <see cref="T:System.IO.Pipelines.PipeReader" /> wrapping the specified <see cref="T:System.IO.Stream" />.</summary>
<param name="stream">The stream that the pipe reader will wrap.</param>
<param name="readerOptions">The options to configure the pipe reader.</param>
<returns>A <see cref="T:System.IO.Pipelines.PipeReader" /> that wraps the <see cref="T:System.IO.Stream" />.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.OnWriterCompleted(System.Action{System.Exception,System.Object},System.Object)">
<summary>Registers a callback that executes when the <see cref="T:System.IO.Pipelines.PipeWriter" /> side of the pipe is completed.</summary>
<param name="callback">The callback to register.</param>
<param name="state">The state object to pass to <paramref name="callback" /> when it's invoked.</param>
</member>
<member name="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)">
<summary>Asynchronously reads a sequence of bytes from the current <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see langword="default" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A <see cref="T:System.Threading.Tasks.ValueTask`1" /> representing the asynchronous read operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.ReadAtLeastAsync(System.Int32,System.Threading.CancellationToken)">
<summary>Asynchronously reads a sequence of bytes from the current <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
<param name="minimumSize">The minimum length that needs to be buffered in order for the call to return.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see langword="default" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A <see cref="T:System.Threading.Tasks.ValueTask`1" /> representing the asynchronous read operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.ReadAtLeastAsyncCore(System.Int32,System.Threading.CancellationToken)">
<summary>Asynchronously reads a sequence of bytes from the current <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
<param name="minimumSize">The minimum length that needs to be buffered in order for the call to return.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see langword="default" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A <see cref="T:System.Threading.Tasks.ValueTask`1" /> representing the asynchronous read operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.TryRead(System.IO.Pipelines.ReadResult@)">
<summary>Attempts to synchronously read data the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
<param name="result">When this method returns <see langword="true" />, this value is set to a <see cref="T:System.IO.Pipelines.ReadResult" /> instance that represents the result of the read call; otherwise, this value is set to <see langword="default" />.</param>
<returns>
<see langword="true" /> if data was available, or if the call was canceled or the writer was completed; otherwise, <see langword="false" />.</returns>
</member>
<member name="T:System.IO.Pipelines.PipeScheduler">
<summary>Abstraction for running <see cref="T:System.IO.Pipelines.PipeReader" /> and <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks and continuations.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeScheduler.#ctor">
<summary>Initializes new a <see cref="T:System.IO.Pipelines.PipeScheduler" /> instance.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeScheduler.Schedule(System.Action{System.Object},System.Object)">
<summary>Requests <paramref name="action" /> to be run on scheduler with <paramref name="state" /> being passed in.</summary>
<param name="action">The single-parameter action delegate to schedule.</param>
<param name="state">The parameter to pass to the <paramref name="action" /> delegate.</param>
</member>
<member name="P:System.IO.Pipelines.PipeScheduler.Inline">
<summary>The <see cref="T:System.IO.Pipelines.PipeScheduler" /> implementation that runs callbacks inline.</summary>
<returns>A <see cref="T:System.IO.Pipelines.PipeScheduler" /> instance that runs callbacks inline.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeScheduler.ThreadPool">
<summary>The <see cref="T:System.IO.Pipelines.PipeScheduler" /> implementation that queues callbacks to the thread pool.</summary>
<returns>A <see cref="T:System.IO.Pipelines.PipeScheduler" /> instance that queues callbacks to the thread pool.</returns>
</member>
<member name="T:System.IO.Pipelines.PipeWriter">
<summary>Defines a class that provides a pipeline to which data can be written.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.#ctor">
<summary>Initializes a new instance of the class.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.Advance(System.Int32)">
<summary>Notifies the <see cref="T:System.IO.Pipelines.PipeWriter" /> that <paramref name="bytes" /> bytes were written to the output <see cref="T:System.Span`1" /> or <see cref="T:System.Memory`1" />. You must call <see cref="M:System.IO.Pipelines.PipeWriter.GetSpan(System.Int32)" /> or <see cref="M:System.IO.Pipelines.PipeWriter.GetMemory(System.Int32)" /> again and use the returned buffer to continue writing more data after calling <see cref="M:System.IO.Pipelines.PipeWriter.Advance(System.Int32)" />; you cannot write to a previously acquired buffer.</summary>
<param name="bytes">The number of bytes written to the <see cref="T:System.Span`1" /> or <see cref="T:System.Memory`1" />.</param>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.AsStream(System.Boolean)">
<summary>Returns a <see cref="T:System.IO.Stream" /> representation of the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
<param name="leaveOpen">An optional flag that indicates whether disposing the returned <see cref="T:System.IO.Stream" /> leaves <see cref="T:System.IO.Pipelines.PipeReader" /> open (<see langword="true" />) or completes <see cref="T:System.IO.Pipelines.PipeReader" /> (<see langword="false" />).</param>
<returns>A stream that represents the <see cref="T:System.IO.Pipelines.PipeWriter" />.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.CancelPendingFlush">
<summary>Cancels the pending <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> or <see cref="M:System.IO.Pipelines.PipeWriter.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)" /> operation without causing the operation to throw and without completing the <see cref="T:System.IO.Pipelines.PipeWriter" />. If there is no pending operation, this cancels the next operation.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.Complete(System.Exception)">
<summary>Marks the <see cref="T:System.IO.Pipelines.PipeWriter" /> as being complete, meaning no more items will be written to it.</summary>
<param name="exception">Optional <see cref="T:System.Exception" /> indicating a failure that's causing the pipeline to complete.</param>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.CompleteAsync(System.Exception)">
<summary>Marks the current pipe writer instance as being complete, meaning no more data will be written to it.</summary>
<param name="exception">An optional exception that indicates the failure that caused the pipeline to complete.</param>
<returns>A value task that represents the asynchronous complete operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.CopyFromAsync(System.IO.Stream,System.Threading.CancellationToken)">
<summary>Asynchronously reads the bytes from the specified stream and writes them to the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
<param name="source">The stream from which the contents will be copied.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A task that represents the asynchronous copy operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.Create(System.IO.Stream,System.IO.Pipelines.StreamPipeWriterOptions)">
<summary>Creates a <see cref="T:System.IO.Pipelines.PipeWriter" /> wrapping the specified <see cref="T:System.IO.Stream" />.</summary>
<param name="stream">The stream that the pipe writer will wrap.</param>
<param name="writerOptions">The options to configure the pipe writer.</param>
<returns>A <see cref="T:System.IO.Pipelines.PipeWriter" /> that wraps the <see cref="T:System.IO.Stream" />.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)">
<summary>Makes bytes written available to <see cref="T:System.IO.Pipelines.PipeReader" /> and runs <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> continuation.</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A task that represents and wraps the asynchronous flush operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.GetMemory(System.Int32)">
<summary>Returns a <see cref="T:System.Memory`1" /> to write to that is at least the requested size, as specified by the <paramref name="sizeHint" /> parameter.</summary>
<param name="sizeHint">The minimum length of the returned <see cref="T:System.Memory`1" />. If 0, a non-empty memory buffer of arbitrary size is returned.</param>
<exception cref="T:System.OutOfMemoryException">The requested buffer size is not available.</exception>
<returns>A memory buffer of at least <paramref name="sizeHint" /> bytes. If <paramref name="sizeHint" /> is 0, returns a non-empty buffer of arbitrary size.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.GetSpan(System.Int32)">
<summary>Returns a <see cref="T:System.Span`1" /> to write to that is at least the requested size, as specified by the <paramref name="sizeHint" /> parameter.</summary>
<param name="sizeHint">The minimum length of the returned <see cref="T:System.Span`1" />. If 0, a non-empty buffer of arbitrary size is returned.</param>
<exception cref="T:System.OutOfMemoryException">The requested buffer size is not available.</exception>
<returns>A buffer of at least <paramref name="sizeHint" /> bytes. If <paramref name="sizeHint" /> is 0, returns a non-empty buffer of arbitrary size.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.OnReaderCompleted(System.Action{System.Exception,System.Object},System.Object)">
<summary>Registers a callback that executes when the <see cref="T:System.IO.Pipelines.PipeReader" /> side of the pipe is completed.</summary>
<param name="callback">The callback to register.</param>
<param name="state">The state object to pass to <paramref name="callback" /> when it's invoked.</param>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)">
<summary>Writes the specified byte memory range to the pipe and makes data accessible to the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
<param name="source">The read-only byte memory region to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A task that represents the asynchronous write operation, and wraps the flush asynchronous operation.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeWriter.CanGetUnflushedBytes">
<summary>Gets a value that indicates whether the current <see cref="T:System.IO.Pipelines.PipeWriter" /> supports reporting the count of unflushed bytes.</summary>
<returns>
<see langword="true" />If a class derived from <see cref="T:System.IO.Pipelines.PipeWriter" /> does not support getting the unflushed bytes, calls to <see cref="P:System.IO.Pipelines.PipeWriter.UnflushedBytes" /> throw <see cref="T:System.NotImplementedException" />.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeWriter.UnflushedBytes">
<summary>When overridden in a derived class, gets the count of unflushed bytes within the current writer.</summary>
<exception cref="T:System.NotImplementedException">The <see cref="T:System.IO.Pipelines.PipeWriter" /> does not support getting the unflushed byte count.</exception>
</member>
<member name="T:System.IO.Pipelines.ReadResult">
<summary>Represents the result of a <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> call.</summary>
</member>
<member name="M:System.IO.Pipelines.ReadResult.#ctor(System.Buffers.ReadOnlySequence{System.Byte},System.Boolean,System.Boolean)">
<summary>Creates a new instance of <see cref="T:System.IO.Pipelines.ReadResult" /> setting <see cref="P:System.IO.Pipelines.ReadResult.IsCanceled" /> and <see cref="P:System.IO.Pipelines.ReadResult.IsCompleted" /> flags.</summary>
<param name="buffer">The read-only sequence containing the bytes of data that were read in the <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> call.</param>
<param name="isCanceled">A flag that indicates if the <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> operation that produced this <see cref="T:System.IO.Pipelines.ReadResult" /> was canceled by <see cref="M:System.IO.Pipelines.PipeReader.CancelPendingRead" />.</param>
<param name="isCompleted">A flag that indicates whether the end of the data stream has been reached.</param>
</member>
<member name="P:System.IO.Pipelines.ReadResult.Buffer">
<summary>Gets the <see cref="T:System.Buffers.ReadOnlySequence`1" /> that was read.</summary>
<returns>A read-only sequence containing the bytes of data that were read in the <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> call.</returns>
</member>
<member name="P:System.IO.Pipelines.ReadResult.IsCanceled">
<summary>Gets a value that indicates whether the current <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> operation was canceled by <see cref="M:System.IO.Pipelines.PipeReader.CancelPendingRead" />.</summary>
<returns>
<see langword="true" /> if the <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> operation that produced this <see cref="T:System.IO.Pipelines.ReadResult" /> was canceled by <see cref="M:System.IO.Pipelines.PipeReader.CancelPendingRead" />; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.IO.Pipelines.ReadResult.IsCompleted">
<summary>Gets a value that indicates whether the end of the data stream has been reached.</summary>
<returns>
<see langword="true" /> if the end of the data stream has been reached; otherwise, <see langword="false" />.</returns>
</member>
<member name="T:System.IO.Pipelines.StreamPipeExtensions">
<summary>Provides extension methods for <see cref="T:System.IO.Stream" /> that support read and write operations directly into pipes.</summary>
</member>
<member name="M:System.IO.Pipelines.StreamPipeExtensions.CopyToAsync(System.IO.Stream,System.IO.Pipelines.PipeWriter,System.Threading.CancellationToken)">
<summary>Asynchronously reads the bytes from the <see cref="T:System.IO.Stream" /> and writes them to the specified <see cref="T:System.IO.Pipelines.PipeWriter" />, using a cancellation token.</summary>
<param name="source">The stream from which the contents of the current stream will be copied.</param>
<param name="destination">The writer to which the contents of the source stream will be copied.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A task that represents the asynchronous copy operation.</returns>
</member>
<member name="T:System.IO.Pipelines.StreamPipeReaderOptions">
<summary>Represents a set of options for controlling the creation of the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
</member>
<member name="M:System.IO.Pipelines.StreamPipeReaderOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.Int32,System.Int32,System.Boolean,System.Boolean)">
<summary>Initializes a <see cref="T:System.IO.Pipelines.StreamPipeReaderOptions" /> instance, optionally specifying a memory pool, a minimum buffer size, a minimum read size, and whether the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes.</summary>
<param name="pool">The memory pool to use when allocating memory. The default value is <see langword="null" />.</param>
<param name="bufferSize">The minimum buffer size to use when renting memory from the <paramref name="pool" />. The default value is 4096.</param>
<param name="minimumReadSize">The threshold of remaining bytes in the buffer before a new buffer is allocated. The default value is 1024.</param>
<param name="leaveOpen">
<see langword="true" /> to leave the underlying stream open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes; <see langword="false" /> to close it. The default is <see langword="false" />.</param>
<param name="useZeroByteReads">
<see langword="true" /> if reads with an empty buffer should be issued to the underlying stream before allocating memory; otherwise, <see langword="false" />.</param>
</member>
<member name="M:System.IO.Pipelines.StreamPipeReaderOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.Int32,System.Int32,System.Boolean)">
<summary>Initializes a <see cref="T:System.IO.Pipelines.StreamPipeReaderOptions" /> instance, optionally specifying a memory pool, a minimum buffer size, a minimum read size, and whether the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes.</summary>
<param name="pool">The memory pool to use when allocating memory. The default value is <see langword="null" />.</param>
<param name="bufferSize">The minimum buffer size to use when renting memory from the <paramref name="pool" />. The default value is 4096.</param>
<param name="minimumReadSize">The threshold of remaining bytes in the buffer before a new buffer is allocated. The default value is 1024.</param>
<param name="leaveOpen">
<see langword="true" /> to leave the underlying stream open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes; <see langword="false" /> to close it. The default is <see langword="false" />.</param>
</member>
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.BufferSize">
<summary>Gets the minimum buffer size to use when renting memory from the <see cref="P:System.IO.Pipelines.StreamPipeReaderOptions.Pool" />.</summary>
<returns>The buffer size.</returns>
</member>
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.LeaveOpen">
<summary>Gets the value that indicates if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes.</summary>
<returns>
<see langword="true" /> if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.MinimumReadSize">
<summary>Gets the threshold of remaining bytes in the buffer before a new buffer is allocated.</summary>
<returns>The minimum read size.</returns>
</member>
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.Pool">
<summary>Gets the <see cref="T:System.Buffers.MemoryPool`1" /> to use when allocating memory.</summary>
<returns>A memory pool instance.</returns>
</member>
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.UseZeroByteReads">
<summary>Gets the value that indicates if reads with an empty buffer should be issued to the underlying stream, in order to wait for data to arrive before allocating memory.</summary>
<returns>
<see langword="true" /> if reads with an empty buffer should be issued to the underlying stream before allocating memory; otherwise, <see langword="false" />.</returns>
</member>
<member name="T:System.IO.Pipelines.StreamPipeWriterOptions">
<summary>Represents a set of options for controlling the creation of the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
</member>
<member name="M:System.IO.Pipelines.StreamPipeWriterOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.Int32,System.Boolean)">
<summary>Initializes a <see cref="T:System.IO.Pipelines.StreamPipeWriterOptions" /> instance, optionally specifying a memory pool, a minimum buffer size, and whether the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes.</summary>
<param name="pool">The memory pool to use when allocating memory. The default value is <see langword="null" />.</param>
<param name="minimumBufferSize">The minimum buffer size to use when renting memory from the <paramref name="pool" />. The default value is 4096.</param>
<param name="leaveOpen">
<see langword="true" /> to leave the underlying stream open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes; <see langword="false" /> to close it. The default is <see langword="false" />.</param>
</member>
<member name="P:System.IO.Pipelines.StreamPipeWriterOptions.LeaveOpen">
<summary>Gets the value that indicates if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes.</summary>
<returns>
<see langword="true" /> if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.IO.Pipelines.StreamPipeWriterOptions.MinimumBufferSize">
<summary>Gets the minimum buffer size to use when renting memory from the <see cref="P:System.IO.Pipelines.StreamPipeWriterOptions.Pool" />.</summary>
<returns>An integer representing the minimum buffer size.</returns>
</member>
<member name="P:System.IO.Pipelines.StreamPipeWriterOptions.Pool">
<summary>Gets the <see cref="T:System.Buffers.MemoryPool`1" /> to use when allocating memory.</summary>
<returns>A memory pool instance.</returns>
</member>
</members>
</doc>

View File

@@ -0,0 +1,391 @@
<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>System.IO.Pipelines</name>
</assembly>
<members>
<member name="T:System.IO.Pipelines.FlushResult">
<summary>Result returned by <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> call.</summary>
</member>
<member name="M:System.IO.Pipelines.FlushResult.#ctor(System.Boolean,System.Boolean)">
<summary>Initializes a new instance of <see cref="T:System.IO.Pipelines.FlushResult" /> struct setting the <see cref="P:System.IO.Pipelines.FlushResult.IsCanceled" /> and <see cref="P:System.IO.Pipelines.FlushResult.IsCompleted" /> flags.</summary>
<param name="isCanceled">
<see langword="true" /> to indicate the current <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> operation that produced this <see cref="T:System.IO.Pipelines.FlushResult" /> was canceled by <see cref="M:System.IO.Pipelines.PipeWriter.CancelPendingFlush" />; otherwise, <see langword="false" />.</param>
<param name="isCompleted">
<see langword="true" /> to indicate the reader is no longer reading data written to the <see cref="T:System.IO.Pipelines.PipeWriter" />.</param>
</member>
<member name="P:System.IO.Pipelines.FlushResult.IsCanceled">
<summary>Gets a value that indicates whether the current <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> operation was canceled by <see cref="M:System.IO.Pipelines.PipeWriter.CancelPendingFlush" />.</summary>
<returns>
<see langword="true" /> if the current <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> operation was canceled by <see cref="M:System.IO.Pipelines.PipeWriter.CancelPendingFlush" />; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.IO.Pipelines.FlushResult.IsCompleted">
<summary>Gets a value that indicates the reader is no longer reading data written to the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
<returns>
<see langword="true" /> if the reader is no longer reading data written to the <see cref="T:System.IO.Pipelines.PipeWriter" />; otherwise, <see langword="false" />.</returns>
</member>
<member name="T:System.IO.Pipelines.IDuplexPipe">
<summary>Defines a class that provides a duplex pipe from which data can be read from and written to.</summary>
</member>
<member name="P:System.IO.Pipelines.IDuplexPipe.Input">
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeReader" /> half of the duplex pipe.</summary>
</member>
<member name="P:System.IO.Pipelines.IDuplexPipe.Output">
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeWriter" /> half of the duplex pipe.</summary>
</member>
<member name="T:System.IO.Pipelines.Pipe">
<summary>The default <see cref="T:System.IO.Pipelines.PipeWriter" /> and <see cref="T:System.IO.Pipelines.PipeReader" /> implementation.</summary>
</member>
<member name="M:System.IO.Pipelines.Pipe.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.IO.Pipelines.Pipe" /> class using <see cref="P:System.IO.Pipelines.PipeOptions.Default" /> as options.</summary>
</member>
<member name="M:System.IO.Pipelines.Pipe.#ctor(System.IO.Pipelines.PipeOptions)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Pipelines.Pipe" /> class with the specified options.</summary>
<param name="options">The set of options for this pipe.</param>
</member>
<member name="M:System.IO.Pipelines.Pipe.Reset">
<summary>Resets the pipe.</summary>
</member>
<member name="P:System.IO.Pipelines.Pipe.Reader">
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeReader" /> for this pipe.</summary>
<returns>A <see cref="T:System.IO.Pipelines.PipeReader" /> instance for this pipe.</returns>
</member>
<member name="P:System.IO.Pipelines.Pipe.Writer">
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeWriter" /> for this pipe.</summary>
<returns>A <see cref="T:System.IO.Pipelines.PipeWriter" /> instance for this pipe.</returns>
</member>
<member name="T:System.IO.Pipelines.PipeOptions">
<summary>Represents a set of <see cref="T:System.IO.Pipelines.Pipe" /> options.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.IO.Pipelines.PipeScheduler,System.IO.Pipelines.PipeScheduler,System.Int64,System.Int64,System.Int32,System.Boolean)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Pipelines.PipeOptions" /> class with the specified parameters.</summary>
<param name="pool">The pool of memory blocks to be used for buffer management.</param>
<param name="readerScheduler">The <see cref="T:System.IO.Pipelines.PipeScheduler" /> to be used to execute <see cref="T:System.IO.Pipelines.PipeReader" /> callbacks and async continuations.</param>
<param name="writerScheduler">The <see cref="T:System.IO.Pipelines.PipeScheduler" /> used to execute <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks and async continuations.</param>
<param name="pauseWriterThreshold">The number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> before <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> starts blocking. A value of zero prevents <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> from ever blocking, effectively making the number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> unlimited.</param>
<param name="resumeWriterThreshold">The number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> stops blocking.</param>
<param name="minimumSegmentSize">The minimum size of the segment requested from <paramref name="pool" />.</param>
<param name="useSynchronizationContext">
<see langword="true" /> if asynchronous continuations should be executed on the <see cref="T:System.Threading.SynchronizationContext" /> they were captured on; <see langword="false" /> otherwise. This takes precedence over the schedulers specified in <see cref="P:System.IO.Pipelines.PipeOptions.ReaderScheduler" /> and <see cref="P:System.IO.Pipelines.PipeOptions.WriterScheduler" />.</param>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.Default">
<summary>Gets the default instance of <see cref="T:System.IO.Pipelines.PipeOptions" />.</summary>
<returns>A <see cref="T:System.IO.Pipelines.PipeOptions" /> object initialized with default parameters.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.MinimumSegmentSize">
<summary>Gets the minimum size of the segment requested from the <see cref="P:System.IO.Pipelines.PipeOptions.Pool" />.</summary>
<returns>The minimum size of the segment requested from the <see cref="P:System.IO.Pipelines.PipeOptions.Pool" />.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.PauseWriterThreshold">
<summary>Gets the number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> starts blocking. A value of zero prevents <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> from ever blocking, effectively making the number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> unlimited.</summary>
<returns>The number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> starts blocking.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.Pool">
<summary>Gets the <see cref="T:System.Buffers.MemoryPool`1" /> object used for buffer management.</summary>
<returns>A pool of memory blocks used for buffer management.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.ReaderScheduler">
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeScheduler" /> used to execute <see cref="T:System.IO.Pipelines.PipeReader" /> callbacks and async continuations.</summary>
<returns>A <see cref="T:System.IO.Pipelines.PipeScheduler" /> that is used to execute <see cref="T:System.IO.Pipelines.PipeReader" /> callbacks and async continuations.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.ResumeWriterThreshold">
<summary>Gets the number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> stops blocking.</summary>
<returns>The number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> stops blocking.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.UseSynchronizationContext">
<summary>Gets a value that determines if asynchronous callbacks and continuations should be executed on the <see cref="T:System.Threading.SynchronizationContext" /> they were captured on. This takes precedence over the schedulers specified in <see cref="P:System.IO.Pipelines.PipeOptions.ReaderScheduler" /> and <see cref="P:System.IO.Pipelines.PipeOptions.WriterScheduler" />.</summary>
<returns>
<see langword="true" /> if asynchronous callbacks and continuations should be executed on the <see cref="T:System.Threading.SynchronizationContext" /> they were captured on; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.WriterScheduler">
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeScheduler" /> used to execute <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks and async continuations.</summary>
<returns>A <see cref="T:System.IO.Pipelines.PipeScheduler" /> object used to execute <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks and async continuations.</returns>
</member>
<member name="T:System.IO.Pipelines.PipeReader">
<summary>Defines a class that provides access to a read side of pipe.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeReader.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.IO.Pipelines.PipeReader" /> class.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeReader.AdvanceTo(System.SequencePosition,System.SequencePosition)">
<summary>Moves forward the pipeline's read cursor to after the consumed data, marking the data as processed, read and examined.</summary>
<param name="consumed">Marks the extent of the data that has been successfully processed.</param>
<param name="examined">Marks the extent of the data that has been read and examined.</param>
</member>
<member name="M:System.IO.Pipelines.PipeReader.AdvanceTo(System.SequencePosition)">
<summary>Moves forward the pipeline's read cursor to after the consumed data, marking the data as processed.</summary>
<param name="consumed">Marks the extent of the data that has been successfully processed.</param>
</member>
<member name="M:System.IO.Pipelines.PipeReader.AsStream(System.Boolean)">
<summary>Returns a <see cref="T:System.IO.Stream" /> representation of the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
<param name="leaveOpen">An optional flag that indicates whether disposing the returned <see cref="T:System.IO.Stream" /> leaves <see cref="T:System.IO.Pipelines.PipeReader" /> open (<see langword="true" />) or completes <see cref="T:System.IO.Pipelines.PipeReader" /> (<see langword="false" />).</param>
<returns>A stream that represents the <see cref="T:System.IO.Pipelines.PipeReader" />.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.CancelPendingRead">
<summary>Cancels the pending <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> operation without causing it to throw and without completing the <see cref="T:System.IO.Pipelines.PipeReader" />. If there is no pending operation, this cancels the next operation.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeReader.Complete(System.Exception)">
<summary>Signals to the producer that the consumer is done reading.</summary>
<param name="exception">Optional <see cref="T:System.Exception" /> indicating a failure that's causing the pipeline to complete.</param>
</member>
<member name="M:System.IO.Pipelines.PipeReader.CompleteAsync(System.Exception)">
<summary>Marks the current pipe reader instance as being complete, meaning no more data will be read from it.</summary>
<param name="exception">An optional exception that indicates the failure that caused the reader to complete.</param>
<returns>A value task that represents the asynchronous complete operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.CopyToAsync(System.IO.Pipelines.PipeWriter,System.Threading.CancellationToken)">
<summary>Asynchronously reads the bytes from the <see cref="T:System.IO.Pipelines.PipeReader" /> and writes them to the specified <see cref="T:System.IO.Pipelines.PipeWriter" />, using a specified cancellation token.</summary>
<param name="destination">The pipe writer to which the contents of the current stream will be copied.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A task that represents the asynchronous copy operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.CopyToAsync(System.IO.Stream,System.Threading.CancellationToken)">
<summary>Asynchronously reads the bytes from the <see cref="T:System.IO.Pipelines.PipeReader" /> and writes them to the specified stream, using a specified cancellation token.</summary>
<param name="destination">The stream to which the contents of the current stream will be copied.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A task that represents the asynchronous copy operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.Create(System.Buffers.ReadOnlySequence{System.Byte})">
<summary>Creates a <see cref="T:System.IO.Pipelines.PipeReader" /> wrapping the specified <see cref="T:System.Buffers.ReadOnlySequence`1" />.</summary>
<param name="sequence">The sequence to wrap.</param>
<returns>A <see cref="T:System.IO.Pipelines.PipeReader" /> that wraps the <see cref="T:System.Buffers.ReadOnlySequence`1" />.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.Create(System.IO.Stream,System.IO.Pipelines.StreamPipeReaderOptions)">
<summary>Creates a <see cref="T:System.IO.Pipelines.PipeReader" /> wrapping the specified <see cref="T:System.IO.Stream" />.</summary>
<param name="stream">The stream that the pipe reader will wrap.</param>
<param name="readerOptions">The options to configure the pipe reader.</param>
<returns>A <see cref="T:System.IO.Pipelines.PipeReader" /> that wraps the <see cref="T:System.IO.Stream" />.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.OnWriterCompleted(System.Action{System.Exception,System.Object},System.Object)">
<summary>Registers a callback that executes when the <see cref="T:System.IO.Pipelines.PipeWriter" /> side of the pipe is completed.</summary>
<param name="callback">The callback to register.</param>
<param name="state">The state object to pass to <paramref name="callback" /> when it's invoked.</param>
</member>
<member name="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)">
<summary>Asynchronously reads a sequence of bytes from the current <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see langword="default" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A <see cref="T:System.Threading.Tasks.ValueTask`1" /> representing the asynchronous read operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.ReadAtLeastAsync(System.Int32,System.Threading.CancellationToken)">
<summary>Asynchronously reads a sequence of bytes from the current <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
<param name="minimumSize">The minimum length that needs to be buffered in order for the call to return.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see langword="default" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A <see cref="T:System.Threading.Tasks.ValueTask`1" /> representing the asynchronous read operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.ReadAtLeastAsyncCore(System.Int32,System.Threading.CancellationToken)">
<summary>Asynchronously reads a sequence of bytes from the current <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
<param name="minimumSize">The minimum length that needs to be buffered in order for the call to return.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see langword="default" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A <see cref="T:System.Threading.Tasks.ValueTask`1" /> representing the asynchronous read operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.TryRead(System.IO.Pipelines.ReadResult@)">
<summary>Attempts to synchronously read data the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
<param name="result">When this method returns <see langword="true" />, this value is set to a <see cref="T:System.IO.Pipelines.ReadResult" /> instance that represents the result of the read call; otherwise, this value is set to <see langword="default" />.</param>
<returns>
<see langword="true" /> if data was available, or if the call was canceled or the writer was completed; otherwise, <see langword="false" />.</returns>
</member>
<member name="T:System.IO.Pipelines.PipeScheduler">
<summary>Abstraction for running <see cref="T:System.IO.Pipelines.PipeReader" /> and <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks and continuations.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeScheduler.#ctor">
<summary>Initializes new a <see cref="T:System.IO.Pipelines.PipeScheduler" /> instance.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeScheduler.Schedule(System.Action{System.Object},System.Object)">
<summary>Requests <paramref name="action" /> to be run on scheduler with <paramref name="state" /> being passed in.</summary>
<param name="action">The single-parameter action delegate to schedule.</param>
<param name="state">The parameter to pass to the <paramref name="action" /> delegate.</param>
</member>
<member name="P:System.IO.Pipelines.PipeScheduler.Inline">
<summary>The <see cref="T:System.IO.Pipelines.PipeScheduler" /> implementation that runs callbacks inline.</summary>
<returns>A <see cref="T:System.IO.Pipelines.PipeScheduler" /> instance that runs callbacks inline.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeScheduler.ThreadPool">
<summary>The <see cref="T:System.IO.Pipelines.PipeScheduler" /> implementation that queues callbacks to the thread pool.</summary>
<returns>A <see cref="T:System.IO.Pipelines.PipeScheduler" /> instance that queues callbacks to the thread pool.</returns>
</member>
<member name="T:System.IO.Pipelines.PipeWriter">
<summary>Defines a class that provides a pipeline to which data can be written.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.#ctor">
<summary>Initializes a new instance of the class.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.Advance(System.Int32)">
<summary>Notifies the <see cref="T:System.IO.Pipelines.PipeWriter" /> that <paramref name="bytes" /> bytes were written to the output <see cref="T:System.Span`1" /> or <see cref="T:System.Memory`1" />. You must call <see cref="M:System.IO.Pipelines.PipeWriter.GetSpan(System.Int32)" /> or <see cref="M:System.IO.Pipelines.PipeWriter.GetMemory(System.Int32)" /> again and use the returned buffer to continue writing more data after calling <see cref="M:System.IO.Pipelines.PipeWriter.Advance(System.Int32)" />; you cannot write to a previously acquired buffer.</summary>
<param name="bytes">The number of bytes written to the <see cref="T:System.Span`1" /> or <see cref="T:System.Memory`1" />.</param>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.AsStream(System.Boolean)">
<summary>Returns a <see cref="T:System.IO.Stream" /> representation of the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
<param name="leaveOpen">An optional flag that indicates whether disposing the returned <see cref="T:System.IO.Stream" /> leaves <see cref="T:System.IO.Pipelines.PipeReader" /> open (<see langword="true" />) or completes <see cref="T:System.IO.Pipelines.PipeReader" /> (<see langword="false" />).</param>
<returns>A stream that represents the <see cref="T:System.IO.Pipelines.PipeWriter" />.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.CancelPendingFlush">
<summary>Cancels the pending <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> or <see cref="M:System.IO.Pipelines.PipeWriter.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)" /> operation without causing the operation to throw and without completing the <see cref="T:System.IO.Pipelines.PipeWriter" />. If there is no pending operation, this cancels the next operation.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.Complete(System.Exception)">
<summary>Marks the <see cref="T:System.IO.Pipelines.PipeWriter" /> as being complete, meaning no more items will be written to it.</summary>
<param name="exception">Optional <see cref="T:System.Exception" /> indicating a failure that's causing the pipeline to complete.</param>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.CompleteAsync(System.Exception)">
<summary>Marks the current pipe writer instance as being complete, meaning no more data will be written to it.</summary>
<param name="exception">An optional exception that indicates the failure that caused the pipeline to complete.</param>
<returns>A value task that represents the asynchronous complete operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.CopyFromAsync(System.IO.Stream,System.Threading.CancellationToken)">
<summary>Asynchronously reads the bytes from the specified stream and writes them to the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
<param name="source">The stream from which the contents will be copied.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A task that represents the asynchronous copy operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.Create(System.IO.Stream,System.IO.Pipelines.StreamPipeWriterOptions)">
<summary>Creates a <see cref="T:System.IO.Pipelines.PipeWriter" /> wrapping the specified <see cref="T:System.IO.Stream" />.</summary>
<param name="stream">The stream that the pipe writer will wrap.</param>
<param name="writerOptions">The options to configure the pipe writer.</param>
<returns>A <see cref="T:System.IO.Pipelines.PipeWriter" /> that wraps the <see cref="T:System.IO.Stream" />.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)">
<summary>Makes bytes written available to <see cref="T:System.IO.Pipelines.PipeReader" /> and runs <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> continuation.</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A task that represents and wraps the asynchronous flush operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.GetMemory(System.Int32)">
<summary>Returns a <see cref="T:System.Memory`1" /> to write to that is at least the requested size, as specified by the <paramref name="sizeHint" /> parameter.</summary>
<param name="sizeHint">The minimum length of the returned <see cref="T:System.Memory`1" />. If 0, a non-empty memory buffer of arbitrary size is returned.</param>
<exception cref="T:System.OutOfMemoryException">The requested buffer size is not available.</exception>
<returns>A memory buffer of at least <paramref name="sizeHint" /> bytes. If <paramref name="sizeHint" /> is 0, returns a non-empty buffer of arbitrary size.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.GetSpan(System.Int32)">
<summary>Returns a <see cref="T:System.Span`1" /> to write to that is at least the requested size, as specified by the <paramref name="sizeHint" /> parameter.</summary>
<param name="sizeHint">The minimum length of the returned <see cref="T:System.Span`1" />. If 0, a non-empty buffer of arbitrary size is returned.</param>
<exception cref="T:System.OutOfMemoryException">The requested buffer size is not available.</exception>
<returns>A buffer of at least <paramref name="sizeHint" /> bytes. If <paramref name="sizeHint" /> is 0, returns a non-empty buffer of arbitrary size.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.OnReaderCompleted(System.Action{System.Exception,System.Object},System.Object)">
<summary>Registers a callback that executes when the <see cref="T:System.IO.Pipelines.PipeReader" /> side of the pipe is completed.</summary>
<param name="callback">The callback to register.</param>
<param name="state">The state object to pass to <paramref name="callback" /> when it's invoked.</param>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)">
<summary>Writes the specified byte memory range to the pipe and makes data accessible to the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
<param name="source">The read-only byte memory region to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A task that represents the asynchronous write operation, and wraps the flush asynchronous operation.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeWriter.CanGetUnflushedBytes">
<summary>Gets a value that indicates whether the current <see cref="T:System.IO.Pipelines.PipeWriter" /> supports reporting the count of unflushed bytes.</summary>
<returns>
<see langword="true" />If a class derived from <see cref="T:System.IO.Pipelines.PipeWriter" /> does not support getting the unflushed bytes, calls to <see cref="P:System.IO.Pipelines.PipeWriter.UnflushedBytes" /> throw <see cref="T:System.NotImplementedException" />.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeWriter.UnflushedBytes">
<summary>When overridden in a derived class, gets the count of unflushed bytes within the current writer.</summary>
<exception cref="T:System.NotImplementedException">The <see cref="T:System.IO.Pipelines.PipeWriter" /> does not support getting the unflushed byte count.</exception>
</member>
<member name="T:System.IO.Pipelines.ReadResult">
<summary>Represents the result of a <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> call.</summary>
</member>
<member name="M:System.IO.Pipelines.ReadResult.#ctor(System.Buffers.ReadOnlySequence{System.Byte},System.Boolean,System.Boolean)">
<summary>Creates a new instance of <see cref="T:System.IO.Pipelines.ReadResult" /> setting <see cref="P:System.IO.Pipelines.ReadResult.IsCanceled" /> and <see cref="P:System.IO.Pipelines.ReadResult.IsCompleted" /> flags.</summary>
<param name="buffer">The read-only sequence containing the bytes of data that were read in the <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> call.</param>
<param name="isCanceled">A flag that indicates if the <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> operation that produced this <see cref="T:System.IO.Pipelines.ReadResult" /> was canceled by <see cref="M:System.IO.Pipelines.PipeReader.CancelPendingRead" />.</param>
<param name="isCompleted">A flag that indicates whether the end of the data stream has been reached.</param>
</member>
<member name="P:System.IO.Pipelines.ReadResult.Buffer">
<summary>Gets the <see cref="T:System.Buffers.ReadOnlySequence`1" /> that was read.</summary>
<returns>A read-only sequence containing the bytes of data that were read in the <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> call.</returns>
</member>
<member name="P:System.IO.Pipelines.ReadResult.IsCanceled">
<summary>Gets a value that indicates whether the current <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> operation was canceled by <see cref="M:System.IO.Pipelines.PipeReader.CancelPendingRead" />.</summary>
<returns>
<see langword="true" /> if the <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> operation that produced this <see cref="T:System.IO.Pipelines.ReadResult" /> was canceled by <see cref="M:System.IO.Pipelines.PipeReader.CancelPendingRead" />; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.IO.Pipelines.ReadResult.IsCompleted">
<summary>Gets a value that indicates whether the end of the data stream has been reached.</summary>
<returns>
<see langword="true" /> if the end of the data stream has been reached; otherwise, <see langword="false" />.</returns>
</member>
<member name="T:System.IO.Pipelines.StreamPipeExtensions">
<summary>Provides extension methods for <see cref="T:System.IO.Stream" /> that support read and write operations directly into pipes.</summary>
</member>
<member name="M:System.IO.Pipelines.StreamPipeExtensions.CopyToAsync(System.IO.Stream,System.IO.Pipelines.PipeWriter,System.Threading.CancellationToken)">
<summary>Asynchronously reads the bytes from the <see cref="T:System.IO.Stream" /> and writes them to the specified <see cref="T:System.IO.Pipelines.PipeWriter" />, using a cancellation token.</summary>
<param name="source">The stream from which the contents of the current stream will be copied.</param>
<param name="destination">The writer to which the contents of the source stream will be copied.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A task that represents the asynchronous copy operation.</returns>
</member>
<member name="T:System.IO.Pipelines.StreamPipeReaderOptions">
<summary>Represents a set of options for controlling the creation of the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
</member>
<member name="M:System.IO.Pipelines.StreamPipeReaderOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.Int32,System.Int32,System.Boolean,System.Boolean)">
<summary>Initializes a <see cref="T:System.IO.Pipelines.StreamPipeReaderOptions" /> instance, optionally specifying a memory pool, a minimum buffer size, a minimum read size, and whether the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes.</summary>
<param name="pool">The memory pool to use when allocating memory. The default value is <see langword="null" />.</param>
<param name="bufferSize">The minimum buffer size to use when renting memory from the <paramref name="pool" />. The default value is 4096.</param>
<param name="minimumReadSize">The threshold of remaining bytes in the buffer before a new buffer is allocated. The default value is 1024.</param>
<param name="leaveOpen">
<see langword="true" /> to leave the underlying stream open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes; <see langword="false" /> to close it. The default is <see langword="false" />.</param>
<param name="useZeroByteReads">
<see langword="true" /> if reads with an empty buffer should be issued to the underlying stream before allocating memory; otherwise, <see langword="false" />.</param>
</member>
<member name="M:System.IO.Pipelines.StreamPipeReaderOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.Int32,System.Int32,System.Boolean)">
<summary>Initializes a <see cref="T:System.IO.Pipelines.StreamPipeReaderOptions" /> instance, optionally specifying a memory pool, a minimum buffer size, a minimum read size, and whether the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes.</summary>
<param name="pool">The memory pool to use when allocating memory. The default value is <see langword="null" />.</param>
<param name="bufferSize">The minimum buffer size to use when renting memory from the <paramref name="pool" />. The default value is 4096.</param>
<param name="minimumReadSize">The threshold of remaining bytes in the buffer before a new buffer is allocated. The default value is 1024.</param>
<param name="leaveOpen">
<see langword="true" /> to leave the underlying stream open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes; <see langword="false" /> to close it. The default is <see langword="false" />.</param>
</member>
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.BufferSize">
<summary>Gets the minimum buffer size to use when renting memory from the <see cref="P:System.IO.Pipelines.StreamPipeReaderOptions.Pool" />.</summary>
<returns>The buffer size.</returns>
</member>
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.LeaveOpen">
<summary>Gets the value that indicates if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes.</summary>
<returns>
<see langword="true" /> if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.MinimumReadSize">
<summary>Gets the threshold of remaining bytes in the buffer before a new buffer is allocated.</summary>
<returns>The minimum read size.</returns>
</member>
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.Pool">
<summary>Gets the <see cref="T:System.Buffers.MemoryPool`1" /> to use when allocating memory.</summary>
<returns>A memory pool instance.</returns>
</member>
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.UseZeroByteReads">
<summary>Gets the value that indicates if reads with an empty buffer should be issued to the underlying stream, in order to wait for data to arrive before allocating memory.</summary>
<returns>
<see langword="true" /> if reads with an empty buffer should be issued to the underlying stream before allocating memory; otherwise, <see langword="false" />.</returns>
</member>
<member name="T:System.IO.Pipelines.StreamPipeWriterOptions">
<summary>Represents a set of options for controlling the creation of the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
</member>
<member name="M:System.IO.Pipelines.StreamPipeWriterOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.Int32,System.Boolean)">
<summary>Initializes a <see cref="T:System.IO.Pipelines.StreamPipeWriterOptions" /> instance, optionally specifying a memory pool, a minimum buffer size, and whether the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes.</summary>
<param name="pool">The memory pool to use when allocating memory. The default value is <see langword="null" />.</param>
<param name="minimumBufferSize">The minimum buffer size to use when renting memory from the <paramref name="pool" />. The default value is 4096.</param>
<param name="leaveOpen">
<see langword="true" /> to leave the underlying stream open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes; <see langword="false" /> to close it. The default is <see langword="false" />.</param>
</member>
<member name="P:System.IO.Pipelines.StreamPipeWriterOptions.LeaveOpen">
<summary>Gets the value that indicates if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes.</summary>
<returns>
<see langword="true" /> if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.IO.Pipelines.StreamPipeWriterOptions.MinimumBufferSize">
<summary>Gets the minimum buffer size to use when renting memory from the <see cref="P:System.IO.Pipelines.StreamPipeWriterOptions.Pool" />.</summary>
<returns>An integer representing the minimum buffer size.</returns>
</member>
<member name="P:System.IO.Pipelines.StreamPipeWriterOptions.Pool">
<summary>Gets the <see cref="T:System.Buffers.MemoryPool`1" /> to use when allocating memory.</summary>
<returns>A memory pool instance.</returns>
</member>
</members>
</doc>

View File

@@ -0,0 +1,391 @@
<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>System.IO.Pipelines</name>
</assembly>
<members>
<member name="T:System.IO.Pipelines.FlushResult">
<summary>Result returned by <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> call.</summary>
</member>
<member name="M:System.IO.Pipelines.FlushResult.#ctor(System.Boolean,System.Boolean)">
<summary>Initializes a new instance of <see cref="T:System.IO.Pipelines.FlushResult" /> struct setting the <see cref="P:System.IO.Pipelines.FlushResult.IsCanceled" /> and <see cref="P:System.IO.Pipelines.FlushResult.IsCompleted" /> flags.</summary>
<param name="isCanceled">
<see langword="true" /> to indicate the current <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> operation that produced this <see cref="T:System.IO.Pipelines.FlushResult" /> was canceled by <see cref="M:System.IO.Pipelines.PipeWriter.CancelPendingFlush" />; otherwise, <see langword="false" />.</param>
<param name="isCompleted">
<see langword="true" /> to indicate the reader is no longer reading data written to the <see cref="T:System.IO.Pipelines.PipeWriter" />.</param>
</member>
<member name="P:System.IO.Pipelines.FlushResult.IsCanceled">
<summary>Gets a value that indicates whether the current <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> operation was canceled by <see cref="M:System.IO.Pipelines.PipeWriter.CancelPendingFlush" />.</summary>
<returns>
<see langword="true" /> if the current <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> operation was canceled by <see cref="M:System.IO.Pipelines.PipeWriter.CancelPendingFlush" />; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.IO.Pipelines.FlushResult.IsCompleted">
<summary>Gets a value that indicates the reader is no longer reading data written to the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
<returns>
<see langword="true" /> if the reader is no longer reading data written to the <see cref="T:System.IO.Pipelines.PipeWriter" />; otherwise, <see langword="false" />.</returns>
</member>
<member name="T:System.IO.Pipelines.IDuplexPipe">
<summary>Defines a class that provides a duplex pipe from which data can be read from and written to.</summary>
</member>
<member name="P:System.IO.Pipelines.IDuplexPipe.Input">
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeReader" /> half of the duplex pipe.</summary>
</member>
<member name="P:System.IO.Pipelines.IDuplexPipe.Output">
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeWriter" /> half of the duplex pipe.</summary>
</member>
<member name="T:System.IO.Pipelines.Pipe">
<summary>The default <see cref="T:System.IO.Pipelines.PipeWriter" /> and <see cref="T:System.IO.Pipelines.PipeReader" /> implementation.</summary>
</member>
<member name="M:System.IO.Pipelines.Pipe.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.IO.Pipelines.Pipe" /> class using <see cref="P:System.IO.Pipelines.PipeOptions.Default" /> as options.</summary>
</member>
<member name="M:System.IO.Pipelines.Pipe.#ctor(System.IO.Pipelines.PipeOptions)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Pipelines.Pipe" /> class with the specified options.</summary>
<param name="options">The set of options for this pipe.</param>
</member>
<member name="M:System.IO.Pipelines.Pipe.Reset">
<summary>Resets the pipe.</summary>
</member>
<member name="P:System.IO.Pipelines.Pipe.Reader">
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeReader" /> for this pipe.</summary>
<returns>A <see cref="T:System.IO.Pipelines.PipeReader" /> instance for this pipe.</returns>
</member>
<member name="P:System.IO.Pipelines.Pipe.Writer">
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeWriter" /> for this pipe.</summary>
<returns>A <see cref="T:System.IO.Pipelines.PipeWriter" /> instance for this pipe.</returns>
</member>
<member name="T:System.IO.Pipelines.PipeOptions">
<summary>Represents a set of <see cref="T:System.IO.Pipelines.Pipe" /> options.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.IO.Pipelines.PipeScheduler,System.IO.Pipelines.PipeScheduler,System.Int64,System.Int64,System.Int32,System.Boolean)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Pipelines.PipeOptions" /> class with the specified parameters.</summary>
<param name="pool">The pool of memory blocks to be used for buffer management.</param>
<param name="readerScheduler">The <see cref="T:System.IO.Pipelines.PipeScheduler" /> to be used to execute <see cref="T:System.IO.Pipelines.PipeReader" /> callbacks and async continuations.</param>
<param name="writerScheduler">The <see cref="T:System.IO.Pipelines.PipeScheduler" /> used to execute <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks and async continuations.</param>
<param name="pauseWriterThreshold">The number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> before <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> starts blocking. A value of zero prevents <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> from ever blocking, effectively making the number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> unlimited.</param>
<param name="resumeWriterThreshold">The number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> stops blocking.</param>
<param name="minimumSegmentSize">The minimum size of the segment requested from <paramref name="pool" />.</param>
<param name="useSynchronizationContext">
<see langword="true" /> if asynchronous continuations should be executed on the <see cref="T:System.Threading.SynchronizationContext" /> they were captured on; <see langword="false" /> otherwise. This takes precedence over the schedulers specified in <see cref="P:System.IO.Pipelines.PipeOptions.ReaderScheduler" /> and <see cref="P:System.IO.Pipelines.PipeOptions.WriterScheduler" />.</param>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.Default">
<summary>Gets the default instance of <see cref="T:System.IO.Pipelines.PipeOptions" />.</summary>
<returns>A <see cref="T:System.IO.Pipelines.PipeOptions" /> object initialized with default parameters.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.MinimumSegmentSize">
<summary>Gets the minimum size of the segment requested from the <see cref="P:System.IO.Pipelines.PipeOptions.Pool" />.</summary>
<returns>The minimum size of the segment requested from the <see cref="P:System.IO.Pipelines.PipeOptions.Pool" />.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.PauseWriterThreshold">
<summary>Gets the number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> starts blocking. A value of zero prevents <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> from ever blocking, effectively making the number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> unlimited.</summary>
<returns>The number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> starts blocking.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.Pool">
<summary>Gets the <see cref="T:System.Buffers.MemoryPool`1" /> object used for buffer management.</summary>
<returns>A pool of memory blocks used for buffer management.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.ReaderScheduler">
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeScheduler" /> used to execute <see cref="T:System.IO.Pipelines.PipeReader" /> callbacks and async continuations.</summary>
<returns>A <see cref="T:System.IO.Pipelines.PipeScheduler" /> that is used to execute <see cref="T:System.IO.Pipelines.PipeReader" /> callbacks and async continuations.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.ResumeWriterThreshold">
<summary>Gets the number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> stops blocking.</summary>
<returns>The number of bytes in the <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> stops blocking.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.UseSynchronizationContext">
<summary>Gets a value that determines if asynchronous callbacks and continuations should be executed on the <see cref="T:System.Threading.SynchronizationContext" /> they were captured on. This takes precedence over the schedulers specified in <see cref="P:System.IO.Pipelines.PipeOptions.ReaderScheduler" /> and <see cref="P:System.IO.Pipelines.PipeOptions.WriterScheduler" />.</summary>
<returns>
<see langword="true" /> if asynchronous callbacks and continuations should be executed on the <see cref="T:System.Threading.SynchronizationContext" /> they were captured on; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeOptions.WriterScheduler">
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeScheduler" /> used to execute <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks and async continuations.</summary>
<returns>A <see cref="T:System.IO.Pipelines.PipeScheduler" /> object used to execute <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks and async continuations.</returns>
</member>
<member name="T:System.IO.Pipelines.PipeReader">
<summary>Defines a class that provides access to a read side of pipe.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeReader.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.IO.Pipelines.PipeReader" /> class.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeReader.AdvanceTo(System.SequencePosition,System.SequencePosition)">
<summary>Moves forward the pipeline's read cursor to after the consumed data, marking the data as processed, read and examined.</summary>
<param name="consumed">Marks the extent of the data that has been successfully processed.</param>
<param name="examined">Marks the extent of the data that has been read and examined.</param>
</member>
<member name="M:System.IO.Pipelines.PipeReader.AdvanceTo(System.SequencePosition)">
<summary>Moves forward the pipeline's read cursor to after the consumed data, marking the data as processed.</summary>
<param name="consumed">Marks the extent of the data that has been successfully processed.</param>
</member>
<member name="M:System.IO.Pipelines.PipeReader.AsStream(System.Boolean)">
<summary>Returns a <see cref="T:System.IO.Stream" /> representation of the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
<param name="leaveOpen">An optional flag that indicates whether disposing the returned <see cref="T:System.IO.Stream" /> leaves <see cref="T:System.IO.Pipelines.PipeReader" /> open (<see langword="true" />) or completes <see cref="T:System.IO.Pipelines.PipeReader" /> (<see langword="false" />).</param>
<returns>A stream that represents the <see cref="T:System.IO.Pipelines.PipeReader" />.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.CancelPendingRead">
<summary>Cancels the pending <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> operation without causing it to throw and without completing the <see cref="T:System.IO.Pipelines.PipeReader" />. If there is no pending operation, this cancels the next operation.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeReader.Complete(System.Exception)">
<summary>Signals to the producer that the consumer is done reading.</summary>
<param name="exception">Optional <see cref="T:System.Exception" /> indicating a failure that's causing the pipeline to complete.</param>
</member>
<member name="M:System.IO.Pipelines.PipeReader.CompleteAsync(System.Exception)">
<summary>Marks the current pipe reader instance as being complete, meaning no more data will be read from it.</summary>
<param name="exception">An optional exception that indicates the failure that caused the reader to complete.</param>
<returns>A value task that represents the asynchronous complete operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.CopyToAsync(System.IO.Pipelines.PipeWriter,System.Threading.CancellationToken)">
<summary>Asynchronously reads the bytes from the <see cref="T:System.IO.Pipelines.PipeReader" /> and writes them to the specified <see cref="T:System.IO.Pipelines.PipeWriter" />, using a specified cancellation token.</summary>
<param name="destination">The pipe writer to which the contents of the current stream will be copied.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A task that represents the asynchronous copy operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.CopyToAsync(System.IO.Stream,System.Threading.CancellationToken)">
<summary>Asynchronously reads the bytes from the <see cref="T:System.IO.Pipelines.PipeReader" /> and writes them to the specified stream, using a specified cancellation token.</summary>
<param name="destination">The stream to which the contents of the current stream will be copied.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A task that represents the asynchronous copy operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.Create(System.Buffers.ReadOnlySequence{System.Byte})">
<summary>Creates a <see cref="T:System.IO.Pipelines.PipeReader" /> wrapping the specified <see cref="T:System.Buffers.ReadOnlySequence`1" />.</summary>
<param name="sequence">The sequence to wrap.</param>
<returns>A <see cref="T:System.IO.Pipelines.PipeReader" /> that wraps the <see cref="T:System.Buffers.ReadOnlySequence`1" />.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.Create(System.IO.Stream,System.IO.Pipelines.StreamPipeReaderOptions)">
<summary>Creates a <see cref="T:System.IO.Pipelines.PipeReader" /> wrapping the specified <see cref="T:System.IO.Stream" />.</summary>
<param name="stream">The stream that the pipe reader will wrap.</param>
<param name="readerOptions">The options to configure the pipe reader.</param>
<returns>A <see cref="T:System.IO.Pipelines.PipeReader" /> that wraps the <see cref="T:System.IO.Stream" />.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.OnWriterCompleted(System.Action{System.Exception,System.Object},System.Object)">
<summary>Registers a callback that executes when the <see cref="T:System.IO.Pipelines.PipeWriter" /> side of the pipe is completed.</summary>
<param name="callback">The callback to register.</param>
<param name="state">The state object to pass to <paramref name="callback" /> when it's invoked.</param>
</member>
<member name="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)">
<summary>Asynchronously reads a sequence of bytes from the current <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see langword="default" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A <see cref="T:System.Threading.Tasks.ValueTask`1" /> representing the asynchronous read operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.ReadAtLeastAsync(System.Int32,System.Threading.CancellationToken)">
<summary>Asynchronously reads a sequence of bytes from the current <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
<param name="minimumSize">The minimum length that needs to be buffered in order for the call to return.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see langword="default" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A <see cref="T:System.Threading.Tasks.ValueTask`1" /> representing the asynchronous read operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.ReadAtLeastAsyncCore(System.Int32,System.Threading.CancellationToken)">
<summary>Asynchronously reads a sequence of bytes from the current <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
<param name="minimumSize">The minimum length that needs to be buffered in order for the call to return.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see langword="default" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A <see cref="T:System.Threading.Tasks.ValueTask`1" /> representing the asynchronous read operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeReader.TryRead(System.IO.Pipelines.ReadResult@)">
<summary>Attempts to synchronously read data the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
<param name="result">When this method returns <see langword="true" />, this value is set to a <see cref="T:System.IO.Pipelines.ReadResult" /> instance that represents the result of the read call; otherwise, this value is set to <see langword="default" />.</param>
<returns>
<see langword="true" /> if data was available, or if the call was canceled or the writer was completed; otherwise, <see langword="false" />.</returns>
</member>
<member name="T:System.IO.Pipelines.PipeScheduler">
<summary>Abstraction for running <see cref="T:System.IO.Pipelines.PipeReader" /> and <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks and continuations.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeScheduler.#ctor">
<summary>Initializes new a <see cref="T:System.IO.Pipelines.PipeScheduler" /> instance.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeScheduler.Schedule(System.Action{System.Object},System.Object)">
<summary>Requests <paramref name="action" /> to be run on scheduler with <paramref name="state" /> being passed in.</summary>
<param name="action">The single-parameter action delegate to schedule.</param>
<param name="state">The parameter to pass to the <paramref name="action" /> delegate.</param>
</member>
<member name="P:System.IO.Pipelines.PipeScheduler.Inline">
<summary>The <see cref="T:System.IO.Pipelines.PipeScheduler" /> implementation that runs callbacks inline.</summary>
<returns>A <see cref="T:System.IO.Pipelines.PipeScheduler" /> instance that runs callbacks inline.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeScheduler.ThreadPool">
<summary>The <see cref="T:System.IO.Pipelines.PipeScheduler" /> implementation that queues callbacks to the thread pool.</summary>
<returns>A <see cref="T:System.IO.Pipelines.PipeScheduler" /> instance that queues callbacks to the thread pool.</returns>
</member>
<member name="T:System.IO.Pipelines.PipeWriter">
<summary>Defines a class that provides a pipeline to which data can be written.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.#ctor">
<summary>Initializes a new instance of the class.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.Advance(System.Int32)">
<summary>Notifies the <see cref="T:System.IO.Pipelines.PipeWriter" /> that <paramref name="bytes" /> bytes were written to the output <see cref="T:System.Span`1" /> or <see cref="T:System.Memory`1" />. You must call <see cref="M:System.IO.Pipelines.PipeWriter.GetSpan(System.Int32)" /> or <see cref="M:System.IO.Pipelines.PipeWriter.GetMemory(System.Int32)" /> again and use the returned buffer to continue writing more data after calling <see cref="M:System.IO.Pipelines.PipeWriter.Advance(System.Int32)" />; you cannot write to a previously acquired buffer.</summary>
<param name="bytes">The number of bytes written to the <see cref="T:System.Span`1" /> or <see cref="T:System.Memory`1" />.</param>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.AsStream(System.Boolean)">
<summary>Returns a <see cref="T:System.IO.Stream" /> representation of the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
<param name="leaveOpen">An optional flag that indicates whether disposing the returned <see cref="T:System.IO.Stream" /> leaves <see cref="T:System.IO.Pipelines.PipeReader" /> open (<see langword="true" />) or completes <see cref="T:System.IO.Pipelines.PipeReader" /> (<see langword="false" />).</param>
<returns>A stream that represents the <see cref="T:System.IO.Pipelines.PipeWriter" />.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.CancelPendingFlush">
<summary>Cancels the pending <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> or <see cref="M:System.IO.Pipelines.PipeWriter.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)" /> operation without causing the operation to throw and without completing the <see cref="T:System.IO.Pipelines.PipeWriter" />. If there is no pending operation, this cancels the next operation.</summary>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.Complete(System.Exception)">
<summary>Marks the <see cref="T:System.IO.Pipelines.PipeWriter" /> as being complete, meaning no more items will be written to it.</summary>
<param name="exception">Optional <see cref="T:System.Exception" /> indicating a failure that's causing the pipeline to complete.</param>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.CompleteAsync(System.Exception)">
<summary>Marks the current pipe writer instance as being complete, meaning no more data will be written to it.</summary>
<param name="exception">An optional exception that indicates the failure that caused the pipeline to complete.</param>
<returns>A value task that represents the asynchronous complete operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.CopyFromAsync(System.IO.Stream,System.Threading.CancellationToken)">
<summary>Asynchronously reads the bytes from the specified stream and writes them to the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
<param name="source">The stream from which the contents will be copied.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A task that represents the asynchronous copy operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.Create(System.IO.Stream,System.IO.Pipelines.StreamPipeWriterOptions)">
<summary>Creates a <see cref="T:System.IO.Pipelines.PipeWriter" /> wrapping the specified <see cref="T:System.IO.Stream" />.</summary>
<param name="stream">The stream that the pipe writer will wrap.</param>
<param name="writerOptions">The options to configure the pipe writer.</param>
<returns>A <see cref="T:System.IO.Pipelines.PipeWriter" /> that wraps the <see cref="T:System.IO.Stream" />.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)">
<summary>Makes bytes written available to <see cref="T:System.IO.Pipelines.PipeReader" /> and runs <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> continuation.</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A task that represents and wraps the asynchronous flush operation.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.GetMemory(System.Int32)">
<summary>Returns a <see cref="T:System.Memory`1" /> to write to that is at least the requested size, as specified by the <paramref name="sizeHint" /> parameter.</summary>
<param name="sizeHint">The minimum length of the returned <see cref="T:System.Memory`1" />. If 0, a non-empty memory buffer of arbitrary size is returned.</param>
<exception cref="T:System.OutOfMemoryException">The requested buffer size is not available.</exception>
<returns>A memory buffer of at least <paramref name="sizeHint" /> bytes. If <paramref name="sizeHint" /> is 0, returns a non-empty buffer of arbitrary size.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.GetSpan(System.Int32)">
<summary>Returns a <see cref="T:System.Span`1" /> to write to that is at least the requested size, as specified by the <paramref name="sizeHint" /> parameter.</summary>
<param name="sizeHint">The minimum length of the returned <see cref="T:System.Span`1" />. If 0, a non-empty buffer of arbitrary size is returned.</param>
<exception cref="T:System.OutOfMemoryException">The requested buffer size is not available.</exception>
<returns>A buffer of at least <paramref name="sizeHint" /> bytes. If <paramref name="sizeHint" /> is 0, returns a non-empty buffer of arbitrary size.</returns>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.OnReaderCompleted(System.Action{System.Exception,System.Object},System.Object)">
<summary>Registers a callback that executes when the <see cref="T:System.IO.Pipelines.PipeReader" /> side of the pipe is completed.</summary>
<param name="callback">The callback to register.</param>
<param name="state">The state object to pass to <paramref name="callback" /> when it's invoked.</param>
</member>
<member name="M:System.IO.Pipelines.PipeWriter.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)">
<summary>Writes the specified byte memory range to the pipe and makes data accessible to the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
<param name="source">The read-only byte memory region to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A task that represents the asynchronous write operation, and wraps the flush asynchronous operation.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeWriter.CanGetUnflushedBytes">
<summary>Gets a value that indicates whether the current <see cref="T:System.IO.Pipelines.PipeWriter" /> supports reporting the count of unflushed bytes.</summary>
<returns>
<see langword="true" />If a class derived from <see cref="T:System.IO.Pipelines.PipeWriter" /> does not support getting the unflushed bytes, calls to <see cref="P:System.IO.Pipelines.PipeWriter.UnflushedBytes" /> throw <see cref="T:System.NotImplementedException" />.</returns>
</member>
<member name="P:System.IO.Pipelines.PipeWriter.UnflushedBytes">
<summary>When overridden in a derived class, gets the count of unflushed bytes within the current writer.</summary>
<exception cref="T:System.NotImplementedException">The <see cref="T:System.IO.Pipelines.PipeWriter" /> does not support getting the unflushed byte count.</exception>
</member>
<member name="T:System.IO.Pipelines.ReadResult">
<summary>Represents the result of a <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> call.</summary>
</member>
<member name="M:System.IO.Pipelines.ReadResult.#ctor(System.Buffers.ReadOnlySequence{System.Byte},System.Boolean,System.Boolean)">
<summary>Creates a new instance of <see cref="T:System.IO.Pipelines.ReadResult" /> setting <see cref="P:System.IO.Pipelines.ReadResult.IsCanceled" /> and <see cref="P:System.IO.Pipelines.ReadResult.IsCompleted" /> flags.</summary>
<param name="buffer">The read-only sequence containing the bytes of data that were read in the <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> call.</param>
<param name="isCanceled">A flag that indicates if the <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> operation that produced this <see cref="T:System.IO.Pipelines.ReadResult" /> was canceled by <see cref="M:System.IO.Pipelines.PipeReader.CancelPendingRead" />.</param>
<param name="isCompleted">A flag that indicates whether the end of the data stream has been reached.</param>
</member>
<member name="P:System.IO.Pipelines.ReadResult.Buffer">
<summary>Gets the <see cref="T:System.Buffers.ReadOnlySequence`1" /> that was read.</summary>
<returns>A read-only sequence containing the bytes of data that were read in the <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> call.</returns>
</member>
<member name="P:System.IO.Pipelines.ReadResult.IsCanceled">
<summary>Gets a value that indicates whether the current <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> operation was canceled by <see cref="M:System.IO.Pipelines.PipeReader.CancelPendingRead" />.</summary>
<returns>
<see langword="true" /> if the <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> operation that produced this <see cref="T:System.IO.Pipelines.ReadResult" /> was canceled by <see cref="M:System.IO.Pipelines.PipeReader.CancelPendingRead" />; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.IO.Pipelines.ReadResult.IsCompleted">
<summary>Gets a value that indicates whether the end of the data stream has been reached.</summary>
<returns>
<see langword="true" /> if the end of the data stream has been reached; otherwise, <see langword="false" />.</returns>
</member>
<member name="T:System.IO.Pipelines.StreamPipeExtensions">
<summary>Provides extension methods for <see cref="T:System.IO.Stream" /> that support read and write operations directly into pipes.</summary>
</member>
<member name="M:System.IO.Pipelines.StreamPipeExtensions.CopyToAsync(System.IO.Stream,System.IO.Pipelines.PipeWriter,System.Threading.CancellationToken)">
<summary>Asynchronously reads the bytes from the <see cref="T:System.IO.Stream" /> and writes them to the specified <see cref="T:System.IO.Pipelines.PipeWriter" />, using a cancellation token.</summary>
<param name="source">The stream from which the contents of the current stream will be copied.</param>
<param name="destination">The writer to which the contents of the source stream will be copied.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
<returns>A task that represents the asynchronous copy operation.</returns>
</member>
<member name="T:System.IO.Pipelines.StreamPipeReaderOptions">
<summary>Represents a set of options for controlling the creation of the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
</member>
<member name="M:System.IO.Pipelines.StreamPipeReaderOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.Int32,System.Int32,System.Boolean,System.Boolean)">
<summary>Initializes a <see cref="T:System.IO.Pipelines.StreamPipeReaderOptions" /> instance, optionally specifying a memory pool, a minimum buffer size, a minimum read size, and whether the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes.</summary>
<param name="pool">The memory pool to use when allocating memory. The default value is <see langword="null" />.</param>
<param name="bufferSize">The minimum buffer size to use when renting memory from the <paramref name="pool" />. The default value is 4096.</param>
<param name="minimumReadSize">The threshold of remaining bytes in the buffer before a new buffer is allocated. The default value is 1024.</param>
<param name="leaveOpen">
<see langword="true" /> to leave the underlying stream open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes; <see langword="false" /> to close it. The default is <see langword="false" />.</param>
<param name="useZeroByteReads">
<see langword="true" /> if reads with an empty buffer should be issued to the underlying stream before allocating memory; otherwise, <see langword="false" />.</param>
</member>
<member name="M:System.IO.Pipelines.StreamPipeReaderOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.Int32,System.Int32,System.Boolean)">
<summary>Initializes a <see cref="T:System.IO.Pipelines.StreamPipeReaderOptions" /> instance, optionally specifying a memory pool, a minimum buffer size, a minimum read size, and whether the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes.</summary>
<param name="pool">The memory pool to use when allocating memory. The default value is <see langword="null" />.</param>
<param name="bufferSize">The minimum buffer size to use when renting memory from the <paramref name="pool" />. The default value is 4096.</param>
<param name="minimumReadSize">The threshold of remaining bytes in the buffer before a new buffer is allocated. The default value is 1024.</param>
<param name="leaveOpen">
<see langword="true" /> to leave the underlying stream open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes; <see langword="false" /> to close it. The default is <see langword="false" />.</param>
</member>
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.BufferSize">
<summary>Gets the minimum buffer size to use when renting memory from the <see cref="P:System.IO.Pipelines.StreamPipeReaderOptions.Pool" />.</summary>
<returns>The buffer size.</returns>
</member>
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.LeaveOpen">
<summary>Gets the value that indicates if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes.</summary>
<returns>
<see langword="true" /> if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.MinimumReadSize">
<summary>Gets the threshold of remaining bytes in the buffer before a new buffer is allocated.</summary>
<returns>The minimum read size.</returns>
</member>
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.Pool">
<summary>Gets the <see cref="T:System.Buffers.MemoryPool`1" /> to use when allocating memory.</summary>
<returns>A memory pool instance.</returns>
</member>
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.UseZeroByteReads">
<summary>Gets the value that indicates if reads with an empty buffer should be issued to the underlying stream, in order to wait for data to arrive before allocating memory.</summary>
<returns>
<see langword="true" /> if reads with an empty buffer should be issued to the underlying stream before allocating memory; otherwise, <see langword="false" />.</returns>
</member>
<member name="T:System.IO.Pipelines.StreamPipeWriterOptions">
<summary>Represents a set of options for controlling the creation of the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
</member>
<member name="M:System.IO.Pipelines.StreamPipeWriterOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.Int32,System.Boolean)">
<summary>Initializes a <see cref="T:System.IO.Pipelines.StreamPipeWriterOptions" /> instance, optionally specifying a memory pool, a minimum buffer size, and whether the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes.</summary>
<param name="pool">The memory pool to use when allocating memory. The default value is <see langword="null" />.</param>
<param name="minimumBufferSize">The minimum buffer size to use when renting memory from the <paramref name="pool" />. The default value is 4096.</param>
<param name="leaveOpen">
<see langword="true" /> to leave the underlying stream open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes; <see langword="false" /> to close it. The default is <see langword="false" />.</param>
</member>
<member name="P:System.IO.Pipelines.StreamPipeWriterOptions.LeaveOpen">
<summary>Gets the value that indicates if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes.</summary>
<returns>
<see langword="true" /> if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.IO.Pipelines.StreamPipeWriterOptions.MinimumBufferSize">
<summary>Gets the minimum buffer size to use when renting memory from the <see cref="P:System.IO.Pipelines.StreamPipeWriterOptions.Pool" />.</summary>
<returns>An integer representing the minimum buffer size.</returns>
</member>
<member name="P:System.IO.Pipelines.StreamPipeWriterOptions.Pool">
<summary>Gets the <see cref="T:System.Buffers.MemoryPool`1" /> to use when allocating memory.</summary>
<returns>A memory pool instance.</returns>
</member>
</members>
</doc>

View File

@@ -1,309 +0,0 @@
.NET Core uses third-party libraries or other resources that may be
distributed under licenses different than the .NET Core software.
In the event that we accidentally failed to list a required notice, please
bring it to our attention. Post an issue or email us:
dotnet@microsoft.com
The attached notices are provided for information only.
License notice for Slicing-by-8
-------------------------------
http://sourceforge.net/projects/slicing-by-8/
Copyright (c) 2004-2006 Intel Corporation - All Rights Reserved
This software program is licensed subject to the BSD License, available at
http://www.opensource.org/licenses/bsd-license.html.
License notice for Unicode data
-------------------------------
http://www.unicode.org/copyright.html#License
Copyright © 1991-2017 Unicode, Inc. All rights reserved.
Distributed under the Terms of Use in http://www.unicode.org/copyright.html.
Permission is hereby granted, free of charge, to any person obtaining
a copy of the Unicode data files and any associated documentation
(the "Data Files") or Unicode software and any associated documentation
(the "Software") to deal in the Data Files or Software
without restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, and/or sell copies of
the Data Files or Software, and to permit persons to whom the Data Files
or Software are furnished to do so, provided that either
(a) this copyright and permission notice appear with all copies
of the Data Files or Software, or
(b) this copyright and permission notice appear in associated
Documentation.
THE DATA FILES AND SOFTWARE ARE PROVIDED "AS IS", WITHOUT WARRANTY OF
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT OF THIRD PARTY RIGHTS.
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS
NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL
DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THE DATA FILES OR SOFTWARE.
Except as contained in this notice, the name of a copyright holder
shall not be used in advertising or otherwise to promote the sale,
use or other dealings in these Data Files or Software without prior
written authorization of the copyright holder.
License notice for Zlib
-----------------------
https://github.com/madler/zlib
http://zlib.net/zlib_license.html
/* zlib.h -- interface of the 'zlib' general purpose compression library
version 1.2.11, January 15th, 2017
Copyright (C) 1995-2017 Jean-loup Gailly and Mark Adler
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
Jean-loup Gailly Mark Adler
jloup@gzip.org madler@alumni.caltech.edu
*/
License notice for Mono
-------------------------------
http://www.mono-project.com/docs/about-mono/
Copyright (c) .NET Foundation Contributors
MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the Software), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
License notice for International Organization for Standardization
-----------------------------------------------------------------
Portions (C) International Organization for Standardization 1986:
Permission to copy in any form is granted for use with
conforming SGML systems and applications as defined in
ISO 8879, provided this notice is included in all copies.
License notice for Intel
------------------------
"Copyright (c) 2004-2006 Intel Corporation - All Rights Reserved
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License notice for Xamarin and Novell
-------------------------------------
Copyright (c) 2015 Xamarin, Inc (http://www.xamarin.com)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
Copyright (c) 2011 Novell, Inc (http://www.novell.com)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
Third party notice for W3C
--------------------------
"W3C SOFTWARE AND DOCUMENT NOTICE AND LICENSE
Status: This license takes effect 13 May, 2015.
This work is being provided by the copyright holders under the following license.
License
By obtaining and/or copying this work, you (the licensee) agree that you have read, understood, and will comply with the following terms and conditions.
Permission to copy, modify, and distribute this work, with or without modification, for any purpose and without fee or royalty is hereby granted, provided that you include the following on ALL copies of the work or portions thereof, including modifications:
The full text of this NOTICE in a location viewable to users of the redistributed or derivative work.
Any pre-existing intellectual property disclaimers, notices, or terms and conditions. If none exist, the W3C Software and Document Short Notice should be included.
Notice of any changes or modifications, through a copyright statement on the new code or document such as "This software or document includes material copied from or derived from [title and URI of the W3C document]. Copyright © [YEAR] W3C® (MIT, ERCIM, Keio, Beihang)."
Disclaimers
THIS WORK IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE OR DOCUMENT WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENT.
The name and trademarks of copyright holders may NOT be used in advertising or publicity pertaining to the work without specific, written prior permission. Title to copyright in this work will at all times remain with copyright holders."
License notice for Bit Twiddling Hacks
--------------------------------------
Bit Twiddling Hacks
By Sean Eron Anderson
seander@cs.stanford.edu
Individually, the code snippets here are in the public domain (unless otherwise
noted) — feel free to use them however you please. The aggregate collection and
descriptions are © 1997-2005 Sean Eron Anderson. The code and descriptions are
distributed in the hope that they will be useful, but WITHOUT ANY WARRANTY and
without even the implied warranty of merchantability or fitness for a particular
purpose.
License notice for Brotli
--------------------------------------
Copyright (c) 2009, 2010, 2013-2016 by the Brotli Authors.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
compress_fragment.c:
Copyright (c) 2011, Google Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the
distribution.
* Neither the name of Google Inc. nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
""AS IS"" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
decode_fuzzer.c:
Copyright (c) 2015 The Chromium Authors. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the
distribution.
* Neither the name of Google Inc. nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
""AS IS"" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."

View File

@@ -1 +0,0 @@
30ab651fcb4354552bd4891619a0bdd81e0ebdbf

Binary file not shown.

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.1 KiB

View File

@@ -0,0 +1,23 @@
The MIT License (MIT)
Copyright (c) .NET Foundation and Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@@ -0,0 +1,132 @@
## About
<!-- A description of the package and where one can find more documentation -->
Provides types for encoding and escaping strings for use in JavaScript, HTML, and URLs.
This package is essential for protecting web applications against cross-site scripting (XSS) attacks by safely encoding text, and it offers extensive support for Unicode, allowing fine-grained control over which characters are encoded and which are left unescaped.
## Key Features
<!-- The key features of this package -->
* Safe encoders for HTML, JavaScript, and URL strings.
* Extensible to support custom encoding scenarios, including the ability to specify Unicode ranges.
* Helps prevent cross-site scripting (XSS) vulnerabilities.
* Flexible Unicode encoding with support for specifying individual or predefined ranges to cover broader sets of characters, including options to avoid escaping specific language character sets.
## How to Use
<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
### Encoding HTML, JavaScript, and URLs
```csharp
using System.Text.Encodings.Web;
string unsafeString = "<script>alert('XSS Attack!');</script>";
// HTML encode the string to safely display it on a web page.
string safeHtml = HtmlEncoder.Default.Encode(unsafeString);
Console.WriteLine(safeHtml);
// &lt;script&gt;alert(&#x27;XSS Attack!&#x27;);&lt;/script&gt;
// JavaScript encode the string to safely include it in a JavaScript context.
string safeJavaScript = JavaScriptEncoder.Default.Encode(unsafeString);
Console.WriteLine(safeJavaScript);
// \u003Cscript\u003Ealert(\u0027XSS Attack!\u0027);\u003C/script\u003E
string urlPart = "user input with spaces and & symbols";
// URL encode the string to safely include it in a URL.
string encodedUrlPart = UrlEncoder.Default.Encode(urlPart);
Console.WriteLine(encodedUrlPart);
// user%20input%20with%20spaces%20and%20%26%20symbols
```
### Custom Encoding Scenario with Specific Unicode Ranges
```csharp
using System.Text.Encodings.Web;
using System.Text.Unicode;
TextEncoderSettings customEncoderSettings = new TextEncoderSettings();
customEncoderSettings.AllowCharacters('!', '*', '-', '.', '_', '~'); // RFC 3986 unreserved characters
customEncoderSettings.AllowRange(new UnicodeRange('a', 26));
customEncoderSettings.AllowRange(new UnicodeRange('A', 26));
customEncoderSettings.AllowRange(new UnicodeRange('0', 10));
// Create a URL encoder with the custom settings
UrlEncoder customUrlEncoder = UrlEncoder.Create(customEncoderSettings);
string customUrlPart = "custom data: (@123!)";
// By default, the symbols '(', ')', and '@' are not encoded
string defaultEncoded = UrlEncoder.Default.Encode(customUrlPart);
Console.WriteLine(defaultEncoded);
// custom%20data%3A%20(@123!)
// Now, the symbols '(', ')', and '@' are also encoded
string customEncoded = customUrlEncoder.Encode(customUrlPart);
Console.WriteLine(customEncoded);
// custom%20data%3A%20%28%40123!%29
```
### Serialization with Specific Unicode Character Sets
By default Cyrillic characters are encoded as Unicode escape sequences in JSON.
```json
{
"Date": "2019-08-01T00:00:00-07:00",
"TemperatureCelsius": 25,
"Summary": "\u0436\u0430\u0440\u043A\u043E"
}
```
This can be customized by providing a custom `JavaScriptEncoder` to `JsonSerializerOptions`:
```csharp
JsonSerializerOptions options = new JsonSerializerOptions
{
Encoder = JavaScriptEncoder.Create(UnicodeRanges.BasicLatin, UnicodeRanges.Cyrillic),
WriteIndented = true
};
jsonString = JsonSerializer.Serialize(weatherForecast, options1);
```
```json
{
"Date": "2019-08-01T00:00:00-07:00",
"TemperatureCelsius": 25,
"Summary": "жарко"
}
```
More information about this can be found in the [How to customize character encoding with System.Text.Json](https://learn.microsoft.com/dotnet/standard/serialization/system-text-json/character-encoding) article.
## Main Types
<!-- The main types provided in this library -->
The main types provided by this library are:
* `System.Text.Encodings.Web.HtmlEncoder`
* `System.Text.Encodings.Web.JavaScriptEncoder`
* `System.Text.Encodings.Web.UrlEncoder`
* `System.Text.Encodings.Web.TextEncoder`
* `System.Text.Encodings.Web.TextEncoderSettings`
* `System.Text.Unicode.UnicodeRange`
* `System.Text.Unicode.UnicodeRanges`
## Additional Documentation
<!-- Links to further documentation. Remove conceptual documentation if not available for the library. -->
* [API documentation](https://learn.microsoft.com/dotnet/api/system.text.encodings.web)
## Feedback & Contributing
<!-- How to provide feedback on this package and contribute to it -->
System.Text.Encodings.Web is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime).

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,6 @@
<Project InitialTargets="NETStandardCompatError_System_Text_Encodings_Web_net462">
<Target Name="NETStandardCompatError_System_Text_Encodings_Web_net462"
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
<Warning Text="System.Text.Encodings.Web 9.0.3 doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to net462 or later. You may also set &lt;SuppressTfmSupportBuildWarnings&gt;true&lt;/SuppressTfmSupportBuildWarnings&gt; in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
</Target>
</Project>

View File

@@ -0,0 +1,6 @@
<Project InitialTargets="NETStandardCompatError_System_Text_Encodings_Web_net8_0">
<Target Name="NETStandardCompatError_System_Text_Encodings_Web_net8_0"
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
<Warning Text="System.Text.Encodings.Web 9.0.3 doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to net8.0 or later. You may also set &lt;SuppressTfmSupportBuildWarnings&gt;true&lt;/SuppressTfmSupportBuildWarnings&gt; in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
</Target>
</Project>

View File

@@ -1,4 +1,5 @@
<?xml version="1.0" encoding="utf-8"?><doc>
<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>System.Text.Encodings.Web</name>
</assembly>
@@ -7,110 +8,154 @@
<summary>Represents an HTML character encoding.</summary>
</member>
<member name="M:System.Text.Encodings.Web.HtmlEncoder.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder"></see> class.</summary>
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> class.</summary>
</member>
<member name="M:System.Text.Encodings.Web.HtmlEncoder.Create(System.Text.Encodings.Web.TextEncoderSettings)">
<summary>Creates a new instance of the HtmlEncoder class with the specified settings.</summary>
<param name="settings">Settings that control how the <see cref="T:System.Text.Encodings.Web.HtmlEncoder"></see> instance encodes, primarily which characters to encode.</param>
<returns>A new instance of the <see cref="System.Text.Encodings.Web.HtmlEncoder"></see> class.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="settings">settings</paramref> is null.</exception>
<param name="settings">Settings that control how the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> instance encodes, primarily which characters to encode.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="settings" /> is <see langword="null" />.</exception>
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> class.</returns>
</member>
<member name="M:System.Text.Encodings.Web.HtmlEncoder.Create(System.Text.Unicode.UnicodeRange[])">
<summary>Creates a new instance of the HtmlEncoder class that specifies characters the encoder is allowed to not encode.</summary>
<param name="allowedRanges">The set of characters that the encoder is allowed to not encode.</param>
<returns>A new instance of the <see cref="System.Text.Encodings.Web.HtmlEncoder"></see> class.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="allowedRanges">allowedRanges</paramref> is null.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="allowedRanges" /> is <see langword="null" />.</exception>
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> class.</returns>
</member>
<member name="P:System.Text.Encodings.Web.HtmlEncoder.Default">
<summary>Gets a built-in instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder"></see> class.</summary>
<returns>A built-in instance of the <see cref="System.Text.Encodings.Web.HtmlEncoder"></see> class.</returns>
<summary>Gets a built-in instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> class.</summary>
<returns>A built-in instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> class.</returns>
</member>
<member name="T:System.Text.Encodings.Web.JavaScriptEncoder">
<summary>Represents a JavaScript character encoding.</summary>
</member>
<member name="M:System.Text.Encodings.Web.JavaScriptEncoder.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder"></see> class.</summary>
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</summary>
</member>
<member name="M:System.Text.Encodings.Web.JavaScriptEncoder.Create(System.Text.Encodings.Web.TextEncoderSettings)">
<summary>Creates a new instance of JavaScriptEncoder class with the specified settings.</summary>
<param name="settings">Settings that control how the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder"></see> instance encodes, primarily which characters to encode.</param>
<returns>A new instance of the <see cref="System.Text.Encodings.Web.JavaScriptEncoder"></see> class.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="settings">settings</paramref> is null.</exception>
<param name="settings">Settings that control how the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> instance encodes, primarily which characters to encode.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="settings" /> is <see langword="null" />.</exception>
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</returns>
</member>
<member name="M:System.Text.Encodings.Web.JavaScriptEncoder.Create(System.Text.Unicode.UnicodeRange[])">
<summary>Creates a new instance of the JavaScriptEncoder class that specifies characters the encoder is allowed to not encode.</summary>
<param name="allowedRanges">The set of characters that the encoder is allowed to not encode.</param>
<returns>A new instance of the <see cref="System.Text.Encodings.Web.JavaScriptEncoder"></see> class.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="allowedRanges">allowedRanges</paramref> is null.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="allowedRanges" /> is <see langword="null" />.</exception>
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</returns>
</member>
<member name="P:System.Text.Encodings.Web.JavaScriptEncoder.Default">
<summary>Gets a built-in instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder"></see> class.</summary>
<returns>A built-in instance of the <see cref="System.Text.Encodings.Web.JavaScriptEncoder"></see> class.</returns>
<summary>Gets a built-in instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</summary>
<returns>A built-in instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</returns>
</member>
<member name="P:System.Text.Encodings.Web.JavaScriptEncoder.UnsafeRelaxedJsonEscaping">
<summary>Gets a built-in JavaScript encoder instance that is less strict about what is encoded.</summary>
<returns>A JavaScript encoder instance.</returns>
</member>
<member name="T:System.Text.Encodings.Web.TextEncoder">
<summary>The base class of web encoders.</summary>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.TextEncoder"></see> class.</summary>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.String)">
<summary>Encodes the supplied string and returns the encoded text as a new string.</summary>
<param name="value">The string to encode.</param>
<returns>The encoded string.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="value">value</paramref> is null.</exception>
<exception cref="T:System.ArgumentException">The <see cref="System.Text.Encodings.Web.TextEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)"></see> method failed. The encoder does not implement <see cref="System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter"></see> correctly.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.IO.TextWriter,System.String)">
<summary>Encodes the specified string to a <see cref="T:System.IO.TextWriter"></see> object.</summary>
<param name="output">The stream to which to write the encoded text.</param>
<param name="value">The string to encode.</param>
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.TextEncoder" /> class.</summary>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.IO.TextWriter,System.Char[],System.Int32,System.Int32)">
<summary>Encodes characters from an array and writes them to a <see cref="T:System.IO.TextWriter"></see> object.</summary>
<summary>Encodes characters from an array and writes them to a <see cref="T:System.IO.TextWriter" /> object.</summary>
<param name="output">The stream to which to write the encoded text.</param>
<param name="value">The array of characters to encode.</param>
<param name="startIndex">The array index of the first character to encode.</param>
<param name="characterCount">The number of characters in the array to encode.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="output">output</paramref> is null.</exception>
<exception cref="T:System.ArgumentException">The <see cref="System.Text.Encodings.Web.TextEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)"></see> method failed. The encoder does not implement <see cref="System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter"></see> correctly.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="value">value</paramref> is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="startIndex">startIndex</paramref> is out of range.</exception>
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="characterCount">characterCount</paramref> is out of range.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="output" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="M:System.Text.Encodings.Web.TextEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)" /> method failed. The encoder does not implement <see cref="P:System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter" /> correctly.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="value" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="startIndex" /> is out of range.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="characterCount" /> is out of range.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.IO.TextWriter,System.String,System.Int32,System.Int32)">
<summary>Encodes a substring and writes it to a <see cref="T:System.IO.TextWriter"></see> object.</summary>
<summary>Encodes a substring and writes it to a <see cref="T:System.IO.TextWriter" /> object.</summary>
<param name="output">The stream to which to write the encoded text.</param>
<param name="value">The string whose substring is to be encoded.</param>
<param name="startIndex">The index where the substring starts.</param>
<param name="characterCount">The number of characters in the substring.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="output">output</paramref> is null.</exception>
<exception cref="T:System.ArgumentException">The <see cref="System.Text.Encodings.Web.TextEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)"></see> method failed. The encoder does not implement <see cref="System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter"></see> correctly.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="value">value</paramref> is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="startIndex">startIndex</paramref> is out of range.</exception>
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="characterCount">characterCount</paramref> is out of range.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="output" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="M:System.Text.Encodings.Web.TextEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)" /> method failed. The encoder does not implement <see cref="P:System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter" /> correctly.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="value" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="startIndex" /> is out of range.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="characterCount" /> is out of range.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.IO.TextWriter,System.String)">
<summary>Encodes the specified string to a <see cref="T:System.IO.TextWriter" /> object.</summary>
<param name="output">The stream to which to write the encoded text.</param>
<param name="value">The string to encode.</param>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.ReadOnlySpan{System.Char},System.Span{System.Char},System.Int32@,System.Int32@,System.Boolean)">
<summary>Encodes the supplied characters.</summary>
<param name="source">A source buffer containing the characters to encode.</param>
<param name="destination">The destination buffer to which the encoded form of <paramref name="source" /> will be written.</param>
<param name="charsConsumed">The number of characters consumed from the <paramref name="source" /> buffer.</param>
<param name="charsWritten">The number of characters written to the <paramref name="destination" /> buffer.</param>
<param name="isFinalBlock">
<see langword="true" /> to indicate there is no further source data that needs to be encoded; otherwise, <see langword="false" />.</param>
<returns>An enumeration value that describes the result of the encoding operation.</returns>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.String)">
<summary>Encodes the supplied string and returns the encoded text as a new string.</summary>
<param name="value">The string to encode.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="value" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="M:System.Text.Encodings.Web.TextEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)" /> method failed. The encoder does not implement <see cref="P:System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter" /> correctly.</exception>
<returns>The encoded string.</returns>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.EncodeUtf8(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@,System.Int32@,System.Boolean)">
<summary>Encodes the supplied UTF-8 text.</summary>
<param name="utf8Source">A source buffer containing the UTF-8 text to encode.</param>
<param name="utf8Destination">The destination buffer to which the encoded form of <paramref name="utf8Source" /> will be written.</param>
<param name="bytesConsumed">The number of bytes consumed from the <paramref name="utf8Source" /> buffer.</param>
<param name="bytesWritten">The number of bytes written to the <paramref name="utf8Destination" /> buffer.</param>
<param name="isFinalBlock">
<see langword="true" /> to indicate there is no further source data that needs to be encoded; otherwise, <see langword="false" />.</param>
<returns>A status code that describes the result of the encoding operation.</returns>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.FindFirstCharacterToEncode(System.Char*,System.Int32)">
<summary>Finds the index of the first character to encode.</summary>
<param name="text">The text buffer to search.</param>
<param name="textLength">The number of characters in <paramref name="text">text</paramref>.</param>
<param name="textLength">The number of characters in <paramref name="text" />.</param>
<returns>The index of the first character to encode.</returns>
</member>
<member name="P:System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter">
<summary>Gets the maximum number of characters that this encoder can generate for each input code point.</summary>
<returns>The maximum number of characters.</returns>
<member name="M:System.Text.Encodings.Web.TextEncoder.FindFirstCharacterToEncodeUtf8(System.ReadOnlySpan{System.Byte})">
<summary>Finds the first element in a UTF-8 text input buffer that would be escaped by the current encoder instance.</summary>
<param name="utf8Text">The UTF-8 text input buffer to search.</param>
<returns>The index of the first element in <paramref name="utf8Text" /> that would be escaped by the current encoder instance, or -1 if no data in <paramref name="utf8Text" /> requires escaping.</returns>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)">
<summary>Encodes a Unicode scalar value and writes it to a buffer.</summary>
<param name="unicodeScalar">A Unicode scalar value.</param>
<param name="buffer">A pointer to the buffer to which to write the encoded text.</param>
<param name="bufferLength">The length of the destination <paramref name="buffer">buffer</paramref> in characters.</param>
<param name="numberOfCharactersWritten">When the method returns, indicates the number of characters written to the <paramref name="buffer">buffer</paramref>.</param>
<returns>false if <paramref name="bufferLength">bufferLength</paramref> is too small to fit the encoded text; otherwise, returns true.</returns>
<param name="bufferLength">The length of the destination <paramref name="buffer" /> in characters.</param>
<param name="numberOfCharactersWritten">When the method returns, indicates the number of characters written to the <paramref name="buffer" />.</param>
<returns>
<see langword="false" /> if <paramref name="bufferLength" /> is too small to fit the encoded text; otherwise, returns <see langword="true" />.</returns>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.WillEncode(System.Int32)">
<summary>Determines if a given Unicode scalar value will be encoded.</summary>
<param name="unicodeScalar">A Unicode scalar value.</param>
<returns>true if the <paramref name="unicodeScalar">unicodeScalar</paramref> value will be encoded by this encoder; otherwise, returns false.</returns>
<returns>
<see langword="true" /> if the <paramref name="unicodeScalar" /> value will be encoded by this encoder; otherwise, returns <see langword="false" />.</returns>
</member>
<member name="P:System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter">
<summary>Gets the maximum number of characters that this encoder can generate for each input code point.</summary>
<returns>The maximum number of characters.</returns>
</member>
<member name="T:System.Text.Encodings.Web.TextEncoderSettings">
<summary>Represents a filter that allows only certain Unicode code points.</summary>
@@ -119,59 +164,67 @@
<summary>Instantiates an empty filter (allows no code points through by default).</summary>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.#ctor(System.Text.Encodings.Web.TextEncoderSettings)">
<summary>Instantiates a filter by cloning the allowed list of another <see cref="T:System.Text.Encodings.Web.TextEncoderSettings"></see> object.</summary>
<param name="other">The other <see cref="T:System.Text.Encodings.Web.TextEncoderSettings"></see> object to be cloned.</param>
<summary>Instantiates a filter by cloning the allowed list of another <see cref="T:System.Text.Encodings.Web.TextEncoderSettings" /> object.</summary>
<param name="other">The other <see cref="T:System.Text.Encodings.Web.TextEncoderSettings" /> object to be cloned.</param>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.#ctor(System.Text.Unicode.UnicodeRange[])">
<summary>Instantiates a filter where only the character ranges specified by <paramref name="allowedRanges">allowedRanges</paramref> are allowed by the filter.</summary>
<summary>Instantiates a filter where only the character ranges specified by <paramref name="allowedRanges" /> are allowed by the filter.</summary>
<param name="allowedRanges">The allowed character ranges.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="allowedRanges">allowedRanges</paramref> is null.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="allowedRanges" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.AllowCharacter(System.Char)">
<summary>Allows the character specified by <paramref name="character">character</paramref> through the filter.</summary>
<summary>Allows the character specified by <paramref name="character" /> through the filter.</summary>
<param name="character">The allowed character.</param>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.AllowCharacters(System.Char[])">
<summary>Allows all characters specified by <paramref name="characters">characters</paramref> through the filter.</summary>
<summary>Allows all characters specified by <paramref name="characters" /> through the filter.</summary>
<param name="characters">The allowed characters.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="characters">characters</paramref> is null.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="characters" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.AllowCodePoints(System.Collections.Generic.IEnumerable{System.Int32})">
<summary>Allows all code points specified by <paramref name="codePoints">codePoints</paramref>.</summary>
<summary>Allows all code points specified by <paramref name="codePoints" />.</summary>
<param name="codePoints">The allowed code points.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="codePoints">codePoints</paramref> is null.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="codePoints" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.AllowRange(System.Text.Unicode.UnicodeRange)">
<summary>Allows all characters specified by <paramref name="range">range</paramref> through the filter.</summary>
<summary>Allows all characters specified by <paramref name="range" /> through the filter.</summary>
<param name="range">The range of characters to be allowed.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="range">range</paramref> is null.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="range" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.AllowRanges(System.Text.Unicode.UnicodeRange[])">
<summary>Allows all characters specified by <paramref name="ranges">ranges</paramref> through the filter.</summary>
<summary>Allows all characters specified by <paramref name="ranges" /> through the filter.</summary>
<param name="ranges">The ranges of characters to be allowed.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="ranges">ranges</paramref> is null.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="ranges" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.Clear">
<summary>Resets this object by disallowing all characters.</summary>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.ForbidCharacter(System.Char)">
<summary>Disallows the character <paramref name="character">character</paramref> through the filter.</summary>
<summary>Disallows the character <paramref name="character" /> through the filter.</summary>
<param name="character">The disallowed character.</param>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.ForbidCharacters(System.Char[])">
<summary>Disallows all characters specified by <paramref name="characters">characters</paramref> through the filter.</summary>
<summary>Disallows all characters specified by <paramref name="characters" /> through the filter.</summary>
<param name="characters">The disallowed characters.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="characters">characters</paramref> is null.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="characters" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.ForbidRange(System.Text.Unicode.UnicodeRange)">
<summary>Disallows all characters specified by <paramref name="range">range</paramref> through the filter.</summary>
<summary>Disallows all characters specified by <paramref name="range" /> through the filter.</summary>
<param name="range">The range of characters to be disallowed.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="range">range</paramref> is null.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="range" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.ForbidRanges(System.Text.Unicode.UnicodeRange[])">
<summary>Disallows all characters specified by <paramref name="ranges">ranges</paramref> through the filter.</summary>
<summary>Disallows all characters specified by <paramref name="ranges" /> through the filter.</summary>
<param name="ranges">The ranges of characters to be disallowed.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="ranges">ranges</paramref> is null.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="ranges" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.GetAllowedCodePoints">
<summary>Gets an enumerator of all allowed code points.</summary>
@@ -181,54 +234,62 @@
<summary>Represents a URL character encoding.</summary>
</member>
<member name="M:System.Text.Encodings.Web.UrlEncoder.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder"></see> class.</summary>
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> class.</summary>
</member>
<member name="M:System.Text.Encodings.Web.UrlEncoder.Create(System.Text.Encodings.Web.TextEncoderSettings)">
<summary>Creates a new instance of UrlEncoder class with the specified settings.</summary>
<param name="settings">Settings that control how the <see cref="T:System.Text.Encodings.Web.UrlEncoder"></see> instance encodes, primarily which characters to encode.</param>
<returns>A new instance of the <see cref="System.Text.Encodings.Web.UrlEncoder"></see> class.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="settings">settings</paramref> is null.</exception>
<param name="settings">Settings that control how the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> instance encodes, primarily which characters to encode.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="settings" /> is <see langword="null" />.</exception>
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> class.</returns>
</member>
<member name="M:System.Text.Encodings.Web.UrlEncoder.Create(System.Text.Unicode.UnicodeRange[])">
<summary>Creates a new instance of the UrlEncoder class that specifies characters the encoder is allowed to not encode.</summary>
<param name="allowedRanges">The set of characters that the encoder is allowed to not encode.</param>
<returns>A new instance of the <see cref="System.Text.Encodings.Web.UrlEncoder"></see> class.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="allowedRanges">allowedRanges</paramref> is null.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="allowedRanges" /> is <see langword="null" />.</exception>
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> class.</returns>
</member>
<member name="P:System.Text.Encodings.Web.UrlEncoder.Default">
<summary>Gets a built-in instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder"></see> class.</summary>
<returns>A built-in instance of the <see cref="System.Text.Encodings.Web.UrlEncoder"></see> class.</returns>
<summary>Gets a built-in instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> class.</summary>
<returns>A built-in instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> class.</returns>
</member>
<member name="T:System.Text.Unicode.UnicodeRange">
<summary>Represents a contiguous range of Unicode code points.</summary>
</member>
<member name="M:System.Text.Unicode.UnicodeRange.#ctor(System.Int32,System.Int32)">
<summary>Creates a new <see cref="T:System.Text.Unicode.UnicodeRange"></see> that includes a specified number of characters starting at a specified Unicode code point.</summary>
<summary>Creates a new <see cref="T:System.Text.Unicode.UnicodeRange" /> that includes a specified number of characters starting at a specified Unicode code point.</summary>
<param name="firstCodePoint">The first code point in the range.</param>
<param name="length">The number of code points in the range.</param>
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="firstCodePoint">firstCodePoint</paramref> is less than zero or greater than 0xFFFF.
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="firstCodePoint" /> is less than zero or greater than 0xFFFF.
-or-
<paramref name="length">length</paramref> is less than zero.
<paramref name="length" /> is less than zero.
-or-
<paramref name="firstCodePoint">firstCodePoint</paramref> plus <paramref name="length">length</paramref> is greater than 0xFFFF.</exception>
<paramref name="firstCodePoint" /> plus <paramref name="length" /> is greater than 0xFFFF.</exception>
</member>
<member name="M:System.Text.Unicode.UnicodeRange.Create(System.Char,System.Char)">
<summary>Creates a new <see cref="T:System.Text.Unicode.UnicodeRange"></see> instance from a span of characters.</summary>
<summary>Creates a new <see cref="T:System.Text.Unicode.UnicodeRange" /> instance from a span of characters.</summary>
<param name="firstCharacter">The first character in the range.</param>
<param name="lastCharacter">The last character in the range.</param>
<returns>A range that includes all characters between <paramref name="firstCharacter">firstCharacter</paramref> and <paramref name="lastCharacter">lastCharacter</paramref>.</returns>
<exception cref="System.ArgumentOutOfRangeException"><paramref name="lastCharacter">lastCharacter</paramref> precedes <paramref name="firstCharacter">firstCharacter</paramref>.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="lastCharacter" /> precedes <paramref name="firstCharacter" />.</exception>
<returns>A range that includes all characters between <paramref name="firstCharacter" /> and <paramref name="lastCharacter" />.</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRange.FirstCodePoint">
<summary>Gets the first code point in the range represented by this <see cref="T:System.Text.Unicode.UnicodeRange"></see> instance.</summary>
<summary>Gets the first code point in the range represented by this <see cref="T:System.Text.Unicode.UnicodeRange" /> instance.</summary>
<returns>The first code point in the range.</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRange.Length">
<summary>Gets the number of code points in the range represented by this <see cref="T:System.Text.Unicode.UnicodeRange"></see> instance.</summary>
<summary>Gets the number of code points in the range represented by this <see cref="T:System.Text.Unicode.UnicodeRange" /> instance.</summary>
<returns>The number of code points in the range.</returns>
</member>
<member name="T:System.Text.Unicode.UnicodeRanges">
<summary>Provides static properties that return predefined <see cref="T:System.Text.Unicode.UnicodeRange"></see> instances that correspond to blocks from the Unicode specification.</summary>
<summary>Provides static properties that return predefined <see cref="T:System.Text.Unicode.UnicodeRange" /> instances that correspond to blocks from the Unicode specification.</summary>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.All">
<summary>Gets a range that consists of the entire Basic Multilingual Plane (BMP), from U+0000 to U+FFFF).</summary>
@@ -246,6 +307,9 @@
<summary>Gets the Arabic Extended-A Unicode block (U+08A0-U+08FF).</summary>
<returns>The Arabic Extended-A Unicode block (U+08A0-U+08FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.ArabicExtendedB">
<summary>A <see cref="T:System.Text.Unicode.UnicodeRange" /> corresponding to the 'Arabic Extended-B' Unicode block (U+0870..U+089F).</summary>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.ArabicPresentationFormsA">
<summary>Gets the Arabic Presentation Forms-A Unicode block (U+FB50-U+FDFF).</summary>
<returns>The Arabic Presentation Forms-A Unicode block (U+FB50-U+FDFF).</returns>
@@ -406,6 +470,9 @@
<summary>Gets the Cyrillic Extended-B Unicode block (U+A640-U+A69F).</summary>
<returns>The Cyrillic Extended-B Unicode block (U+A640-U+A69F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CyrillicExtendedC">
<summary>A <see cref="T:System.Text.Unicode.UnicodeRange" /> corresponding to the 'Cyrillic Extended-C' Unicode block (U+1C80..U+1C8F).</summary>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CyrillicSupplement">
<summary>Gets the Cyrillic Supplement Unicode block (U+0500-U+052F).</summary>
<returns>The Cyrillic Supplement Unicode block (U+0500-U+052F).</returns>
@@ -458,6 +525,9 @@
<summary>Gets the Georgian Unicode block (U+10A0-U+10FF).</summary>
<returns>The Georgian Unicode block (U+10A0-U+10FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.GeorgianExtended">
<summary>A <see cref="T:System.Text.Unicode.UnicodeRange" /> corresponding to the 'Georgian Extended' Unicode block (U+1C90..U+1CBF).</summary>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.GeorgianSupplement">
<summary>Gets the Georgian Supplement Unicode block (U+2D00-U+2D2F).</summary>
<returns>The Georgian Supplement Unicode block (U+2D00-U+2D2F).</returns>
@@ -782,6 +852,9 @@
<summary>Gets the Syriac Unicode block (U+0700-U+074F).</summary>
<returns>The Syriac Unicode block (U+0700-U+074F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.SyriacSupplement">
<summary>A <see cref="T:System.Text.Unicode.UnicodeRange" /> corresponding to the 'Syriac Supplement' Unicode block (U+0860..U+086F).</summary>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Tagalog">
<summary>Gets the Tagalog Unicode block (U+1700-U+171F).</summary>
<returns>The Tagalog Unicode block (U+1700-U+171F).</returns>

View File

@@ -1,4 +1,5 @@
<?xml version="1.0" encoding="utf-8"?><doc>
<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>System.Text.Encodings.Web</name>
</assembly>
@@ -7,110 +8,154 @@
<summary>Represents an HTML character encoding.</summary>
</member>
<member name="M:System.Text.Encodings.Web.HtmlEncoder.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder"></see> class.</summary>
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> class.</summary>
</member>
<member name="M:System.Text.Encodings.Web.HtmlEncoder.Create(System.Text.Encodings.Web.TextEncoderSettings)">
<summary>Creates a new instance of the HtmlEncoder class with the specified settings.</summary>
<param name="settings">Settings that control how the <see cref="T:System.Text.Encodings.Web.HtmlEncoder"></see> instance encodes, primarily which characters to encode.</param>
<returns>A new instance of the <see cref="System.Text.Encodings.Web.HtmlEncoder"></see> class.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="settings">settings</paramref> is null.</exception>
<param name="settings">Settings that control how the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> instance encodes, primarily which characters to encode.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="settings" /> is <see langword="null" />.</exception>
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> class.</returns>
</member>
<member name="M:System.Text.Encodings.Web.HtmlEncoder.Create(System.Text.Unicode.UnicodeRange[])">
<summary>Creates a new instance of the HtmlEncoder class that specifies characters the encoder is allowed to not encode.</summary>
<param name="allowedRanges">The set of characters that the encoder is allowed to not encode.</param>
<returns>A new instance of the <see cref="System.Text.Encodings.Web.HtmlEncoder"></see> class.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="allowedRanges">allowedRanges</paramref> is null.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="allowedRanges" /> is <see langword="null" />.</exception>
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> class.</returns>
</member>
<member name="P:System.Text.Encodings.Web.HtmlEncoder.Default">
<summary>Gets a built-in instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder"></see> class.</summary>
<returns>A built-in instance of the <see cref="System.Text.Encodings.Web.HtmlEncoder"></see> class.</returns>
<summary>Gets a built-in instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> class.</summary>
<returns>A built-in instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> class.</returns>
</member>
<member name="T:System.Text.Encodings.Web.JavaScriptEncoder">
<summary>Represents a JavaScript character encoding.</summary>
</member>
<member name="M:System.Text.Encodings.Web.JavaScriptEncoder.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder"></see> class.</summary>
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</summary>
</member>
<member name="M:System.Text.Encodings.Web.JavaScriptEncoder.Create(System.Text.Encodings.Web.TextEncoderSettings)">
<summary>Creates a new instance of JavaScriptEncoder class with the specified settings.</summary>
<param name="settings">Settings that control how the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder"></see> instance encodes, primarily which characters to encode.</param>
<returns>A new instance of the <see cref="System.Text.Encodings.Web.JavaScriptEncoder"></see> class.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="settings">settings</paramref> is null.</exception>
<param name="settings">Settings that control how the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> instance encodes, primarily which characters to encode.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="settings" /> is <see langword="null" />.</exception>
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</returns>
</member>
<member name="M:System.Text.Encodings.Web.JavaScriptEncoder.Create(System.Text.Unicode.UnicodeRange[])">
<summary>Creates a new instance of the JavaScriptEncoder class that specifies characters the encoder is allowed to not encode.</summary>
<param name="allowedRanges">The set of characters that the encoder is allowed to not encode.</param>
<returns>A new instance of the <see cref="System.Text.Encodings.Web.JavaScriptEncoder"></see> class.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="allowedRanges">allowedRanges</paramref> is null.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="allowedRanges" /> is <see langword="null" />.</exception>
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</returns>
</member>
<member name="P:System.Text.Encodings.Web.JavaScriptEncoder.Default">
<summary>Gets a built-in instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder"></see> class.</summary>
<returns>A built-in instance of the <see cref="System.Text.Encodings.Web.JavaScriptEncoder"></see> class.</returns>
<summary>Gets a built-in instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</summary>
<returns>A built-in instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</returns>
</member>
<member name="P:System.Text.Encodings.Web.JavaScriptEncoder.UnsafeRelaxedJsonEscaping">
<summary>Gets a built-in JavaScript encoder instance that is less strict about what is encoded.</summary>
<returns>A JavaScript encoder instance.</returns>
</member>
<member name="T:System.Text.Encodings.Web.TextEncoder">
<summary>The base class of web encoders.</summary>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.TextEncoder"></see> class.</summary>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.String)">
<summary>Encodes the supplied string and returns the encoded text as a new string.</summary>
<param name="value">The string to encode.</param>
<returns>The encoded string.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="value">value</paramref> is null.</exception>
<exception cref="T:System.ArgumentException">The <see cref="System.Text.Encodings.Web.TextEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)"></see> method failed. The encoder does not implement <see cref="System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter"></see> correctly.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.IO.TextWriter,System.String)">
<summary>Encodes the specified string to a <see cref="T:System.IO.TextWriter"></see> object.</summary>
<param name="output">The stream to which to write the encoded text.</param>
<param name="value">The string to encode.</param>
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.TextEncoder" /> class.</summary>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.IO.TextWriter,System.Char[],System.Int32,System.Int32)">
<summary>Encodes characters from an array and writes them to a <see cref="T:System.IO.TextWriter"></see> object.</summary>
<summary>Encodes characters from an array and writes them to a <see cref="T:System.IO.TextWriter" /> object.</summary>
<param name="output">The stream to which to write the encoded text.</param>
<param name="value">The array of characters to encode.</param>
<param name="startIndex">The array index of the first character to encode.</param>
<param name="characterCount">The number of characters in the array to encode.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="output">output</paramref> is null.</exception>
<exception cref="T:System.ArgumentException">The <see cref="System.Text.Encodings.Web.TextEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)"></see> method failed. The encoder does not implement <see cref="System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter"></see> correctly.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="value">value</paramref> is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="startIndex">startIndex</paramref> is out of range.</exception>
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="characterCount">characterCount</paramref> is out of range.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="output" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="M:System.Text.Encodings.Web.TextEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)" /> method failed. The encoder does not implement <see cref="P:System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter" /> correctly.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="value" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="startIndex" /> is out of range.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="characterCount" /> is out of range.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.IO.TextWriter,System.String,System.Int32,System.Int32)">
<summary>Encodes a substring and writes it to a <see cref="T:System.IO.TextWriter"></see> object.</summary>
<summary>Encodes a substring and writes it to a <see cref="T:System.IO.TextWriter" /> object.</summary>
<param name="output">The stream to which to write the encoded text.</param>
<param name="value">The string whose substring is to be encoded.</param>
<param name="startIndex">The index where the substring starts.</param>
<param name="characterCount">The number of characters in the substring.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="output">output</paramref> is null.</exception>
<exception cref="T:System.ArgumentException">The <see cref="System.Text.Encodings.Web.TextEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)"></see> method failed. The encoder does not implement <see cref="System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter"></see> correctly.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="value">value</paramref> is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="startIndex">startIndex</paramref> is out of range.</exception>
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="characterCount">characterCount</paramref> is out of range.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="output" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="M:System.Text.Encodings.Web.TextEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)" /> method failed. The encoder does not implement <see cref="P:System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter" /> correctly.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="value" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="startIndex" /> is out of range.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="characterCount" /> is out of range.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.IO.TextWriter,System.String)">
<summary>Encodes the specified string to a <see cref="T:System.IO.TextWriter" /> object.</summary>
<param name="output">The stream to which to write the encoded text.</param>
<param name="value">The string to encode.</param>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.ReadOnlySpan{System.Char},System.Span{System.Char},System.Int32@,System.Int32@,System.Boolean)">
<summary>Encodes the supplied characters.</summary>
<param name="source">A source buffer containing the characters to encode.</param>
<param name="destination">The destination buffer to which the encoded form of <paramref name="source" /> will be written.</param>
<param name="charsConsumed">The number of characters consumed from the <paramref name="source" /> buffer.</param>
<param name="charsWritten">The number of characters written to the <paramref name="destination" /> buffer.</param>
<param name="isFinalBlock">
<see langword="true" /> to indicate there is no further source data that needs to be encoded; otherwise, <see langword="false" />.</param>
<returns>An enumeration value that describes the result of the encoding operation.</returns>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.String)">
<summary>Encodes the supplied string and returns the encoded text as a new string.</summary>
<param name="value">The string to encode.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="value" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="M:System.Text.Encodings.Web.TextEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)" /> method failed. The encoder does not implement <see cref="P:System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter" /> correctly.</exception>
<returns>The encoded string.</returns>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.EncodeUtf8(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@,System.Int32@,System.Boolean)">
<summary>Encodes the supplied UTF-8 text.</summary>
<param name="utf8Source">A source buffer containing the UTF-8 text to encode.</param>
<param name="utf8Destination">The destination buffer to which the encoded form of <paramref name="utf8Source" /> will be written.</param>
<param name="bytesConsumed">The number of bytes consumed from the <paramref name="utf8Source" /> buffer.</param>
<param name="bytesWritten">The number of bytes written to the <paramref name="utf8Destination" /> buffer.</param>
<param name="isFinalBlock">
<see langword="true" /> to indicate there is no further source data that needs to be encoded; otherwise, <see langword="false" />.</param>
<returns>A status code that describes the result of the encoding operation.</returns>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.FindFirstCharacterToEncode(System.Char*,System.Int32)">
<summary>Finds the index of the first character to encode.</summary>
<param name="text">The text buffer to search.</param>
<param name="textLength">The number of characters in <paramref name="text">text</paramref>.</param>
<param name="textLength">The number of characters in <paramref name="text" />.</param>
<returns>The index of the first character to encode.</returns>
</member>
<member name="P:System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter">
<summary>Gets the maximum number of characters that this encoder can generate for each input code point.</summary>
<returns>The maximum number of characters.</returns>
<member name="M:System.Text.Encodings.Web.TextEncoder.FindFirstCharacterToEncodeUtf8(System.ReadOnlySpan{System.Byte})">
<summary>Finds the first element in a UTF-8 text input buffer that would be escaped by the current encoder instance.</summary>
<param name="utf8Text">The UTF-8 text input buffer to search.</param>
<returns>The index of the first element in <paramref name="utf8Text" /> that would be escaped by the current encoder instance, or -1 if no data in <paramref name="utf8Text" /> requires escaping.</returns>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)">
<summary>Encodes a Unicode scalar value and writes it to a buffer.</summary>
<param name="unicodeScalar">A Unicode scalar value.</param>
<param name="buffer">A pointer to the buffer to which to write the encoded text.</param>
<param name="bufferLength">The length of the destination <paramref name="buffer">buffer</paramref> in characters.</param>
<param name="numberOfCharactersWritten">When the method returns, indicates the number of characters written to the <paramref name="buffer">buffer</paramref>.</param>
<returns>false if <paramref name="bufferLength">bufferLength</paramref> is too small to fit the encoded text; otherwise, returns true.</returns>
<param name="bufferLength">The length of the destination <paramref name="buffer" /> in characters.</param>
<param name="numberOfCharactersWritten">When the method returns, indicates the number of characters written to the <paramref name="buffer" />.</param>
<returns>
<see langword="false" /> if <paramref name="bufferLength" /> is too small to fit the encoded text; otherwise, returns <see langword="true" />.</returns>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.WillEncode(System.Int32)">
<summary>Determines if a given Unicode scalar value will be encoded.</summary>
<param name="unicodeScalar">A Unicode scalar value.</param>
<returns>true if the <paramref name="unicodeScalar">unicodeScalar</paramref> value will be encoded by this encoder; otherwise, returns false.</returns>
<returns>
<see langword="true" /> if the <paramref name="unicodeScalar" /> value will be encoded by this encoder; otherwise, returns <see langword="false" />.</returns>
</member>
<member name="P:System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter">
<summary>Gets the maximum number of characters that this encoder can generate for each input code point.</summary>
<returns>The maximum number of characters.</returns>
</member>
<member name="T:System.Text.Encodings.Web.TextEncoderSettings">
<summary>Represents a filter that allows only certain Unicode code points.</summary>
@@ -119,59 +164,67 @@
<summary>Instantiates an empty filter (allows no code points through by default).</summary>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.#ctor(System.Text.Encodings.Web.TextEncoderSettings)">
<summary>Instantiates a filter by cloning the allowed list of another <see cref="T:System.Text.Encodings.Web.TextEncoderSettings"></see> object.</summary>
<param name="other">The other <see cref="T:System.Text.Encodings.Web.TextEncoderSettings"></see> object to be cloned.</param>
<summary>Instantiates a filter by cloning the allowed list of another <see cref="T:System.Text.Encodings.Web.TextEncoderSettings" /> object.</summary>
<param name="other">The other <see cref="T:System.Text.Encodings.Web.TextEncoderSettings" /> object to be cloned.</param>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.#ctor(System.Text.Unicode.UnicodeRange[])">
<summary>Instantiates a filter where only the character ranges specified by <paramref name="allowedRanges">allowedRanges</paramref> are allowed by the filter.</summary>
<summary>Instantiates a filter where only the character ranges specified by <paramref name="allowedRanges" /> are allowed by the filter.</summary>
<param name="allowedRanges">The allowed character ranges.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="allowedRanges">allowedRanges</paramref> is null.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="allowedRanges" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.AllowCharacter(System.Char)">
<summary>Allows the character specified by <paramref name="character">character</paramref> through the filter.</summary>
<summary>Allows the character specified by <paramref name="character" /> through the filter.</summary>
<param name="character">The allowed character.</param>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.AllowCharacters(System.Char[])">
<summary>Allows all characters specified by <paramref name="characters">characters</paramref> through the filter.</summary>
<summary>Allows all characters specified by <paramref name="characters" /> through the filter.</summary>
<param name="characters">The allowed characters.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="characters">characters</paramref> is null.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="characters" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.AllowCodePoints(System.Collections.Generic.IEnumerable{System.Int32})">
<summary>Allows all code points specified by <paramref name="codePoints">codePoints</paramref>.</summary>
<summary>Allows all code points specified by <paramref name="codePoints" />.</summary>
<param name="codePoints">The allowed code points.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="codePoints">codePoints</paramref> is null.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="codePoints" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.AllowRange(System.Text.Unicode.UnicodeRange)">
<summary>Allows all characters specified by <paramref name="range">range</paramref> through the filter.</summary>
<summary>Allows all characters specified by <paramref name="range" /> through the filter.</summary>
<param name="range">The range of characters to be allowed.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="range">range</paramref> is null.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="range" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.AllowRanges(System.Text.Unicode.UnicodeRange[])">
<summary>Allows all characters specified by <paramref name="ranges">ranges</paramref> through the filter.</summary>
<summary>Allows all characters specified by <paramref name="ranges" /> through the filter.</summary>
<param name="ranges">The ranges of characters to be allowed.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="ranges">ranges</paramref> is null.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="ranges" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.Clear">
<summary>Resets this object by disallowing all characters.</summary>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.ForbidCharacter(System.Char)">
<summary>Disallows the character <paramref name="character">character</paramref> through the filter.</summary>
<summary>Disallows the character <paramref name="character" /> through the filter.</summary>
<param name="character">The disallowed character.</param>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.ForbidCharacters(System.Char[])">
<summary>Disallows all characters specified by <paramref name="characters">characters</paramref> through the filter.</summary>
<summary>Disallows all characters specified by <paramref name="characters" /> through the filter.</summary>
<param name="characters">The disallowed characters.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="characters">characters</paramref> is null.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="characters" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.ForbidRange(System.Text.Unicode.UnicodeRange)">
<summary>Disallows all characters specified by <paramref name="range">range</paramref> through the filter.</summary>
<summary>Disallows all characters specified by <paramref name="range" /> through the filter.</summary>
<param name="range">The range of characters to be disallowed.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="range">range</paramref> is null.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="range" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.ForbidRanges(System.Text.Unicode.UnicodeRange[])">
<summary>Disallows all characters specified by <paramref name="ranges">ranges</paramref> through the filter.</summary>
<summary>Disallows all characters specified by <paramref name="ranges" /> through the filter.</summary>
<param name="ranges">The ranges of characters to be disallowed.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="ranges">ranges</paramref> is null.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="ranges" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.GetAllowedCodePoints">
<summary>Gets an enumerator of all allowed code points.</summary>
@@ -181,54 +234,62 @@
<summary>Represents a URL character encoding.</summary>
</member>
<member name="M:System.Text.Encodings.Web.UrlEncoder.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder"></see> class.</summary>
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> class.</summary>
</member>
<member name="M:System.Text.Encodings.Web.UrlEncoder.Create(System.Text.Encodings.Web.TextEncoderSettings)">
<summary>Creates a new instance of UrlEncoder class with the specified settings.</summary>
<param name="settings">Settings that control how the <see cref="T:System.Text.Encodings.Web.UrlEncoder"></see> instance encodes, primarily which characters to encode.</param>
<returns>A new instance of the <see cref="System.Text.Encodings.Web.UrlEncoder"></see> class.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="settings">settings</paramref> is null.</exception>
<param name="settings">Settings that control how the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> instance encodes, primarily which characters to encode.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="settings" /> is <see langword="null" />.</exception>
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> class.</returns>
</member>
<member name="M:System.Text.Encodings.Web.UrlEncoder.Create(System.Text.Unicode.UnicodeRange[])">
<summary>Creates a new instance of the UrlEncoder class that specifies characters the encoder is allowed to not encode.</summary>
<param name="allowedRanges">The set of characters that the encoder is allowed to not encode.</param>
<returns>A new instance of the <see cref="System.Text.Encodings.Web.UrlEncoder"></see> class.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="allowedRanges">allowedRanges</paramref> is null.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="allowedRanges" /> is <see langword="null" />.</exception>
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> class.</returns>
</member>
<member name="P:System.Text.Encodings.Web.UrlEncoder.Default">
<summary>Gets a built-in instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder"></see> class.</summary>
<returns>A built-in instance of the <see cref="System.Text.Encodings.Web.UrlEncoder"></see> class.</returns>
<summary>Gets a built-in instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> class.</summary>
<returns>A built-in instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> class.</returns>
</member>
<member name="T:System.Text.Unicode.UnicodeRange">
<summary>Represents a contiguous range of Unicode code points.</summary>
</member>
<member name="M:System.Text.Unicode.UnicodeRange.#ctor(System.Int32,System.Int32)">
<summary>Creates a new <see cref="T:System.Text.Unicode.UnicodeRange"></see> that includes a specified number of characters starting at a specified Unicode code point.</summary>
<summary>Creates a new <see cref="T:System.Text.Unicode.UnicodeRange" /> that includes a specified number of characters starting at a specified Unicode code point.</summary>
<param name="firstCodePoint">The first code point in the range.</param>
<param name="length">The number of code points in the range.</param>
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="firstCodePoint">firstCodePoint</paramref> is less than zero or greater than 0xFFFF.
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="firstCodePoint" /> is less than zero or greater than 0xFFFF.
-or-
<paramref name="length">length</paramref> is less than zero.
<paramref name="length" /> is less than zero.
-or-
<paramref name="firstCodePoint">firstCodePoint</paramref> plus <paramref name="length">length</paramref> is greater than 0xFFFF.</exception>
<paramref name="firstCodePoint" /> plus <paramref name="length" /> is greater than 0xFFFF.</exception>
</member>
<member name="M:System.Text.Unicode.UnicodeRange.Create(System.Char,System.Char)">
<summary>Creates a new <see cref="T:System.Text.Unicode.UnicodeRange"></see> instance from a span of characters.</summary>
<summary>Creates a new <see cref="T:System.Text.Unicode.UnicodeRange" /> instance from a span of characters.</summary>
<param name="firstCharacter">The first character in the range.</param>
<param name="lastCharacter">The last character in the range.</param>
<returns>A range that includes all characters between <paramref name="firstCharacter">firstCharacter</paramref> and <paramref name="lastCharacter">lastCharacter</paramref>.</returns>
<exception cref="System.ArgumentOutOfRangeException"><paramref name="lastCharacter">lastCharacter</paramref> precedes <paramref name="firstCharacter">firstCharacter</paramref>.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="lastCharacter" /> precedes <paramref name="firstCharacter" />.</exception>
<returns>A range that includes all characters between <paramref name="firstCharacter" /> and <paramref name="lastCharacter" />.</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRange.FirstCodePoint">
<summary>Gets the first code point in the range represented by this <see cref="T:System.Text.Unicode.UnicodeRange"></see> instance.</summary>
<summary>Gets the first code point in the range represented by this <see cref="T:System.Text.Unicode.UnicodeRange" /> instance.</summary>
<returns>The first code point in the range.</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRange.Length">
<summary>Gets the number of code points in the range represented by this <see cref="T:System.Text.Unicode.UnicodeRange"></see> instance.</summary>
<summary>Gets the number of code points in the range represented by this <see cref="T:System.Text.Unicode.UnicodeRange" /> instance.</summary>
<returns>The number of code points in the range.</returns>
</member>
<member name="T:System.Text.Unicode.UnicodeRanges">
<summary>Provides static properties that return predefined <see cref="T:System.Text.Unicode.UnicodeRange"></see> instances that correspond to blocks from the Unicode specification.</summary>
<summary>Provides static properties that return predefined <see cref="T:System.Text.Unicode.UnicodeRange" /> instances that correspond to blocks from the Unicode specification.</summary>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.All">
<summary>Gets a range that consists of the entire Basic Multilingual Plane (BMP), from U+0000 to U+FFFF).</summary>
@@ -246,6 +307,9 @@
<summary>Gets the Arabic Extended-A Unicode block (U+08A0-U+08FF).</summary>
<returns>The Arabic Extended-A Unicode block (U+08A0-U+08FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.ArabicExtendedB">
<summary>A <see cref="T:System.Text.Unicode.UnicodeRange" /> corresponding to the 'Arabic Extended-B' Unicode block (U+0870..U+089F).</summary>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.ArabicPresentationFormsA">
<summary>Gets the Arabic Presentation Forms-A Unicode block (U+FB50-U+FDFF).</summary>
<returns>The Arabic Presentation Forms-A Unicode block (U+FB50-U+FDFF).</returns>
@@ -406,6 +470,9 @@
<summary>Gets the Cyrillic Extended-B Unicode block (U+A640-U+A69F).</summary>
<returns>The Cyrillic Extended-B Unicode block (U+A640-U+A69F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CyrillicExtendedC">
<summary>A <see cref="T:System.Text.Unicode.UnicodeRange" /> corresponding to the 'Cyrillic Extended-C' Unicode block (U+1C80..U+1C8F).</summary>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CyrillicSupplement">
<summary>Gets the Cyrillic Supplement Unicode block (U+0500-U+052F).</summary>
<returns>The Cyrillic Supplement Unicode block (U+0500-U+052F).</returns>
@@ -458,6 +525,9 @@
<summary>Gets the Georgian Unicode block (U+10A0-U+10FF).</summary>
<returns>The Georgian Unicode block (U+10A0-U+10FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.GeorgianExtended">
<summary>A <see cref="T:System.Text.Unicode.UnicodeRange" /> corresponding to the 'Georgian Extended' Unicode block (U+1C90..U+1CBF).</summary>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.GeorgianSupplement">
<summary>Gets the Georgian Supplement Unicode block (U+2D00-U+2D2F).</summary>
<returns>The Georgian Supplement Unicode block (U+2D00-U+2D2F).</returns>
@@ -782,6 +852,9 @@
<summary>Gets the Syriac Unicode block (U+0700-U+074F).</summary>
<returns>The Syriac Unicode block (U+0700-U+074F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.SyriacSupplement">
<summary>A <see cref="T:System.Text.Unicode.UnicodeRange" /> corresponding to the 'Syriac Supplement' Unicode block (U+0860..U+086F).</summary>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Tagalog">
<summary>Gets the Tagalog Unicode block (U+1700-U+171F).</summary>
<returns>The Tagalog Unicode block (U+1700-U+171F).</returns>

View File

@@ -0,0 +1,939 @@
<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>System.Text.Encodings.Web</name>
</assembly>
<members>
<member name="T:System.Text.Encodings.Web.HtmlEncoder">
<summary>Represents an HTML character encoding.</summary>
</member>
<member name="M:System.Text.Encodings.Web.HtmlEncoder.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> class.</summary>
</member>
<member name="M:System.Text.Encodings.Web.HtmlEncoder.Create(System.Text.Encodings.Web.TextEncoderSettings)">
<summary>Creates a new instance of the HtmlEncoder class with the specified settings.</summary>
<param name="settings">Settings that control how the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> instance encodes, primarily which characters to encode.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="settings" /> is <see langword="null" />.</exception>
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> class.</returns>
</member>
<member name="M:System.Text.Encodings.Web.HtmlEncoder.Create(System.Text.Unicode.UnicodeRange[])">
<summary>Creates a new instance of the HtmlEncoder class that specifies characters the encoder is allowed to not encode.</summary>
<param name="allowedRanges">The set of characters that the encoder is allowed to not encode.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="allowedRanges" /> is <see langword="null" />.</exception>
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> class.</returns>
</member>
<member name="P:System.Text.Encodings.Web.HtmlEncoder.Default">
<summary>Gets a built-in instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> class.</summary>
<returns>A built-in instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> class.</returns>
</member>
<member name="T:System.Text.Encodings.Web.JavaScriptEncoder">
<summary>Represents a JavaScript character encoding.</summary>
</member>
<member name="M:System.Text.Encodings.Web.JavaScriptEncoder.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</summary>
</member>
<member name="M:System.Text.Encodings.Web.JavaScriptEncoder.Create(System.Text.Encodings.Web.TextEncoderSettings)">
<summary>Creates a new instance of JavaScriptEncoder class with the specified settings.</summary>
<param name="settings">Settings that control how the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> instance encodes, primarily which characters to encode.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="settings" /> is <see langword="null" />.</exception>
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</returns>
</member>
<member name="M:System.Text.Encodings.Web.JavaScriptEncoder.Create(System.Text.Unicode.UnicodeRange[])">
<summary>Creates a new instance of the JavaScriptEncoder class that specifies characters the encoder is allowed to not encode.</summary>
<param name="allowedRanges">The set of characters that the encoder is allowed to not encode.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="allowedRanges" /> is <see langword="null" />.</exception>
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</returns>
</member>
<member name="P:System.Text.Encodings.Web.JavaScriptEncoder.Default">
<summary>Gets a built-in instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</summary>
<returns>A built-in instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</returns>
</member>
<member name="P:System.Text.Encodings.Web.JavaScriptEncoder.UnsafeRelaxedJsonEscaping">
<summary>Gets a built-in JavaScript encoder instance that is less strict about what is encoded.</summary>
<returns>A JavaScript encoder instance.</returns>
</member>
<member name="T:System.Text.Encodings.Web.TextEncoder">
<summary>The base class of web encoders.</summary>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.TextEncoder" /> class.</summary>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.IO.TextWriter,System.Char[],System.Int32,System.Int32)">
<summary>Encodes characters from an array and writes them to a <see cref="T:System.IO.TextWriter" /> object.</summary>
<param name="output">The stream to which to write the encoded text.</param>
<param name="value">The array of characters to encode.</param>
<param name="startIndex">The array index of the first character to encode.</param>
<param name="characterCount">The number of characters in the array to encode.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="output" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="M:System.Text.Encodings.Web.TextEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)" /> method failed. The encoder does not implement <see cref="P:System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter" /> correctly.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="value" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="startIndex" /> is out of range.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="characterCount" /> is out of range.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.IO.TextWriter,System.String,System.Int32,System.Int32)">
<summary>Encodes a substring and writes it to a <see cref="T:System.IO.TextWriter" /> object.</summary>
<param name="output">The stream to which to write the encoded text.</param>
<param name="value">The string whose substring is to be encoded.</param>
<param name="startIndex">The index where the substring starts.</param>
<param name="characterCount">The number of characters in the substring.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="output" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="M:System.Text.Encodings.Web.TextEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)" /> method failed. The encoder does not implement <see cref="P:System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter" /> correctly.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="value" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="startIndex" /> is out of range.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="characterCount" /> is out of range.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.IO.TextWriter,System.String)">
<summary>Encodes the specified string to a <see cref="T:System.IO.TextWriter" /> object.</summary>
<param name="output">The stream to which to write the encoded text.</param>
<param name="value">The string to encode.</param>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.ReadOnlySpan{System.Char},System.Span{System.Char},System.Int32@,System.Int32@,System.Boolean)">
<summary>Encodes the supplied characters.</summary>
<param name="source">A source buffer containing the characters to encode.</param>
<param name="destination">The destination buffer to which the encoded form of <paramref name="source" /> will be written.</param>
<param name="charsConsumed">The number of characters consumed from the <paramref name="source" /> buffer.</param>
<param name="charsWritten">The number of characters written to the <paramref name="destination" /> buffer.</param>
<param name="isFinalBlock">
<see langword="true" /> to indicate there is no further source data that needs to be encoded; otherwise, <see langword="false" />.</param>
<returns>An enumeration value that describes the result of the encoding operation.</returns>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.String)">
<summary>Encodes the supplied string and returns the encoded text as a new string.</summary>
<param name="value">The string to encode.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="value" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="M:System.Text.Encodings.Web.TextEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)" /> method failed. The encoder does not implement <see cref="P:System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter" /> correctly.</exception>
<returns>The encoded string.</returns>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.EncodeUtf8(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@,System.Int32@,System.Boolean)">
<summary>Encodes the supplied UTF-8 text.</summary>
<param name="utf8Source">A source buffer containing the UTF-8 text to encode.</param>
<param name="utf8Destination">The destination buffer to which the encoded form of <paramref name="utf8Source" /> will be written.</param>
<param name="bytesConsumed">The number of bytes consumed from the <paramref name="utf8Source" /> buffer.</param>
<param name="bytesWritten">The number of bytes written to the <paramref name="utf8Destination" /> buffer.</param>
<param name="isFinalBlock">
<see langword="true" /> to indicate there is no further source data that needs to be encoded; otherwise, <see langword="false" />.</param>
<returns>A status code that describes the result of the encoding operation.</returns>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.FindFirstCharacterToEncode(System.Char*,System.Int32)">
<summary>Finds the index of the first character to encode.</summary>
<param name="text">The text buffer to search.</param>
<param name="textLength">The number of characters in <paramref name="text" />.</param>
<returns>The index of the first character to encode.</returns>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.FindFirstCharacterToEncodeUtf8(System.ReadOnlySpan{System.Byte})">
<summary>Finds the first element in a UTF-8 text input buffer that would be escaped by the current encoder instance.</summary>
<param name="utf8Text">The UTF-8 text input buffer to search.</param>
<returns>The index of the first element in <paramref name="utf8Text" /> that would be escaped by the current encoder instance, or -1 if no data in <paramref name="utf8Text" /> requires escaping.</returns>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)">
<summary>Encodes a Unicode scalar value and writes it to a buffer.</summary>
<param name="unicodeScalar">A Unicode scalar value.</param>
<param name="buffer">A pointer to the buffer to which to write the encoded text.</param>
<param name="bufferLength">The length of the destination <paramref name="buffer" /> in characters.</param>
<param name="numberOfCharactersWritten">When the method returns, indicates the number of characters written to the <paramref name="buffer" />.</param>
<returns>
<see langword="false" /> if <paramref name="bufferLength" /> is too small to fit the encoded text; otherwise, returns <see langword="true" />.</returns>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.WillEncode(System.Int32)">
<summary>Determines if a given Unicode scalar value will be encoded.</summary>
<param name="unicodeScalar">A Unicode scalar value.</param>
<returns>
<see langword="true" /> if the <paramref name="unicodeScalar" /> value will be encoded by this encoder; otherwise, returns <see langword="false" />.</returns>
</member>
<member name="P:System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter">
<summary>Gets the maximum number of characters that this encoder can generate for each input code point.</summary>
<returns>The maximum number of characters.</returns>
</member>
<member name="T:System.Text.Encodings.Web.TextEncoderSettings">
<summary>Represents a filter that allows only certain Unicode code points.</summary>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.#ctor">
<summary>Instantiates an empty filter (allows no code points through by default).</summary>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.#ctor(System.Text.Encodings.Web.TextEncoderSettings)">
<summary>Instantiates a filter by cloning the allowed list of another <see cref="T:System.Text.Encodings.Web.TextEncoderSettings" /> object.</summary>
<param name="other">The other <see cref="T:System.Text.Encodings.Web.TextEncoderSettings" /> object to be cloned.</param>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.#ctor(System.Text.Unicode.UnicodeRange[])">
<summary>Instantiates a filter where only the character ranges specified by <paramref name="allowedRanges" /> are allowed by the filter.</summary>
<param name="allowedRanges">The allowed character ranges.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="allowedRanges" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.AllowCharacter(System.Char)">
<summary>Allows the character specified by <paramref name="character" /> through the filter.</summary>
<param name="character">The allowed character.</param>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.AllowCharacters(System.Char[])">
<summary>Allows all characters specified by <paramref name="characters" /> through the filter.</summary>
<param name="characters">The allowed characters.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="characters" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.AllowCodePoints(System.Collections.Generic.IEnumerable{System.Int32})">
<summary>Allows all code points specified by <paramref name="codePoints" />.</summary>
<param name="codePoints">The allowed code points.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="codePoints" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.AllowRange(System.Text.Unicode.UnicodeRange)">
<summary>Allows all characters specified by <paramref name="range" /> through the filter.</summary>
<param name="range">The range of characters to be allowed.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="range" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.AllowRanges(System.Text.Unicode.UnicodeRange[])">
<summary>Allows all characters specified by <paramref name="ranges" /> through the filter.</summary>
<param name="ranges">The ranges of characters to be allowed.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="ranges" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.Clear">
<summary>Resets this object by disallowing all characters.</summary>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.ForbidCharacter(System.Char)">
<summary>Disallows the character <paramref name="character" /> through the filter.</summary>
<param name="character">The disallowed character.</param>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.ForbidCharacters(System.Char[])">
<summary>Disallows all characters specified by <paramref name="characters" /> through the filter.</summary>
<param name="characters">The disallowed characters.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="characters" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.ForbidRange(System.Text.Unicode.UnicodeRange)">
<summary>Disallows all characters specified by <paramref name="range" /> through the filter.</summary>
<param name="range">The range of characters to be disallowed.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="range" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.ForbidRanges(System.Text.Unicode.UnicodeRange[])">
<summary>Disallows all characters specified by <paramref name="ranges" /> through the filter.</summary>
<param name="ranges">The ranges of characters to be disallowed.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="ranges" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.GetAllowedCodePoints">
<summary>Gets an enumerator of all allowed code points.</summary>
<returns>The enumerator of allowed code points.</returns>
</member>
<member name="T:System.Text.Encodings.Web.UrlEncoder">
<summary>Represents a URL character encoding.</summary>
</member>
<member name="M:System.Text.Encodings.Web.UrlEncoder.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> class.</summary>
</member>
<member name="M:System.Text.Encodings.Web.UrlEncoder.Create(System.Text.Encodings.Web.TextEncoderSettings)">
<summary>Creates a new instance of UrlEncoder class with the specified settings.</summary>
<param name="settings">Settings that control how the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> instance encodes, primarily which characters to encode.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="settings" /> is <see langword="null" />.</exception>
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> class.</returns>
</member>
<member name="M:System.Text.Encodings.Web.UrlEncoder.Create(System.Text.Unicode.UnicodeRange[])">
<summary>Creates a new instance of the UrlEncoder class that specifies characters the encoder is allowed to not encode.</summary>
<param name="allowedRanges">The set of characters that the encoder is allowed to not encode.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="allowedRanges" /> is <see langword="null" />.</exception>
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> class.</returns>
</member>
<member name="P:System.Text.Encodings.Web.UrlEncoder.Default">
<summary>Gets a built-in instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> class.</summary>
<returns>A built-in instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> class.</returns>
</member>
<member name="T:System.Text.Unicode.UnicodeRange">
<summary>Represents a contiguous range of Unicode code points.</summary>
</member>
<member name="M:System.Text.Unicode.UnicodeRange.#ctor(System.Int32,System.Int32)">
<summary>Creates a new <see cref="T:System.Text.Unicode.UnicodeRange" /> that includes a specified number of characters starting at a specified Unicode code point.</summary>
<param name="firstCodePoint">The first code point in the range.</param>
<param name="length">The number of code points in the range.</param>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="firstCodePoint" /> is less than zero or greater than 0xFFFF.
-or-
<paramref name="length" /> is less than zero.
-or-
<paramref name="firstCodePoint" /> plus <paramref name="length" /> is greater than 0xFFFF.</exception>
</member>
<member name="M:System.Text.Unicode.UnicodeRange.Create(System.Char,System.Char)">
<summary>Creates a new <see cref="T:System.Text.Unicode.UnicodeRange" /> instance from a span of characters.</summary>
<param name="firstCharacter">The first character in the range.</param>
<param name="lastCharacter">The last character in the range.</param>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="lastCharacter" /> precedes <paramref name="firstCharacter" />.</exception>
<returns>A range that includes all characters between <paramref name="firstCharacter" /> and <paramref name="lastCharacter" />.</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRange.FirstCodePoint">
<summary>Gets the first code point in the range represented by this <see cref="T:System.Text.Unicode.UnicodeRange" /> instance.</summary>
<returns>The first code point in the range.</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRange.Length">
<summary>Gets the number of code points in the range represented by this <see cref="T:System.Text.Unicode.UnicodeRange" /> instance.</summary>
<returns>The number of code points in the range.</returns>
</member>
<member name="T:System.Text.Unicode.UnicodeRanges">
<summary>Provides static properties that return predefined <see cref="T:System.Text.Unicode.UnicodeRange" /> instances that correspond to blocks from the Unicode specification.</summary>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.All">
<summary>Gets a range that consists of the entire Basic Multilingual Plane (BMP), from U+0000 to U+FFFF).</summary>
<returns>A range that consists of the entire BMP.</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.AlphabeticPresentationForms">
<summary>Gets the Alphabetic Presentation Forms Unicode block (U+FB00-U+FB4F).</summary>
<returns>The Alphabetic Presentation Forms Unicode block (U+FB00-U+FB4F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Arabic">
<summary>Gets the Arabic Unicode block (U+0600-U+06FF).</summary>
<returns>The Arabic Unicode block (U+0600-U+06FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.ArabicExtendedA">
<summary>Gets the Arabic Extended-A Unicode block (U+08A0-U+08FF).</summary>
<returns>The Arabic Extended-A Unicode block (U+08A0-U+08FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.ArabicExtendedB">
<summary>A <see cref="T:System.Text.Unicode.UnicodeRange" /> corresponding to the 'Arabic Extended-B' Unicode block (U+0870..U+089F).</summary>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.ArabicPresentationFormsA">
<summary>Gets the Arabic Presentation Forms-A Unicode block (U+FB50-U+FDFF).</summary>
<returns>The Arabic Presentation Forms-A Unicode block (U+FB50-U+FDFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.ArabicPresentationFormsB">
<summary>Gets the Arabic Presentation Forms-B Unicode block (U+FE70-U+FEFF).</summary>
<returns>The Arabic Presentation Forms-B Unicode block (U+FE70-U+FEFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.ArabicSupplement">
<summary>Gets the Arabic Supplement Unicode block (U+0750-U+077F).</summary>
<returns>The Arabic Supplement Unicode block (U+0750-U+077F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Armenian">
<summary>Gets the Armenian Unicode block (U+0530-U+058F).</summary>
<returns>The Armenian Unicode block (U+0530-U+058F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Arrows">
<summary>Gets the Arrows Unicode block (U+2190-U+21FF).</summary>
<returns>The Arrows Unicode block (U+2190-U+21FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Balinese">
<summary>Gets the Balinese Unicode block (U+1B00-U+1B7F).</summary>
<returns>The Balinese Unicode block (U+1B00-U+1B7F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Bamum">
<summary>Gets the Bamum Unicode block (U+A6A0-U+A6FF).</summary>
<returns>The Bamum Unicode block (U+A6A0-U+A6FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.BasicLatin">
<summary>Gets the Basic Latin Unicode block (U+0021-U+007F).</summary>
<returns>The Basic Latin Unicode block (U+0021-U+007F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Batak">
<summary>Gets the Batak Unicode block (U+1BC0-U+1BFF).</summary>
<returns>The Batak Unicode block (U+1BC0-U+1BFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Bengali">
<summary>Gets the Bengali Unicode block (U+0980-U+09FF).</summary>
<returns>The Bengali Unicode block (U+0980-U+09FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.BlockElements">
<summary>Gets the Block Elements Unicode block (U+2580-U+259F).</summary>
<returns>The Block Elements Unicode block (U+2580-U+259F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Bopomofo">
<summary>Gets the Bopomofo Unicode block (U+3100-U+312F).</summary>
<returns>The Bopomofo Unicode block (U+3105-U+312F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.BopomofoExtended">
<summary>Gets the Bopomofo Extended Unicode block (U+31A0-U+31BF).</summary>
<returns>The Bopomofo Extended Unicode block (U+31A0-U+31BF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.BoxDrawing">
<summary>Gets the Box Drawing Unicode block (U+2500-U+257F).</summary>
<returns>The Box Drawing Unicode block (U+2500-U+257F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.BraillePatterns">
<summary>Gets the Braille Patterns Unicode block (U+2800-U+28FF).</summary>
<returns>The Braille Patterns Unicode block (U+2800-U+28FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Buginese">
<summary>Gets the Buginese Unicode block (U+1A00-U+1A1F).</summary>
<returns>The Buginese Unicode block (U+1A00-U+1A1F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Buhid">
<summary>Gets the Buhid Unicode block (U+1740-U+175F).</summary>
<returns>The Buhid Unicode block (U+1740-U+175F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Cham">
<summary>Gets the Cham Unicode block (U+AA00-U+AA5F).</summary>
<returns>The Cham Unicode block (U+AA00-U+AA5F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Cherokee">
<summary>Gets the Cherokee Unicode block (U+13A0-U+13FF).</summary>
<returns>The Cherokee Unicode block (U+13A0-U+13FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CherokeeSupplement">
<summary>Gets the Cherokee Supplement Unicode block (U+AB70-U+ABBF).</summary>
<returns>The Cherokee Supplement Unicode block (U+AB70-U+ABBF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CjkCompatibility">
<summary>Gets the CJK Compatibility Unicode block (U+3300-U+33FF).</summary>
<returns>The CJK Compatibility Unicode block (U+3300-U+33FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CjkCompatibilityForms">
<summary>Gets the CJK Compatibility Forms Unicode block (U+FE30-U+FE4F).</summary>
<returns>The CJK Compatibility Forms Unicode block (U+FE30-U+FE4F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CjkCompatibilityIdeographs">
<summary>Gets the CJK Compatibility Ideographs Unicode block (U+F900-U+FAD9).</summary>
<returns>The CJK Compatibility Ideographs Unicode block (U+F900-U+FAD9).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CjkRadicalsSupplement">
<summary>Gets the CJK Radicals Supplement Unicode block (U+2E80-U+2EFF).</summary>
<returns>The CJK Radicals Supplement Unicode block (U+2E80-U+2EFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CjkStrokes">
<summary>Gets the CJK Strokes Unicode block (U+31C0-U+31EF).</summary>
<returns>The CJK Strokes Unicode block (U+31C0-U+31EF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CjkSymbolsandPunctuation">
<summary>Gets the CJK Symbols and Punctuation Unicode block (U+3000-U+303F).</summary>
<returns>The CJK Symbols and Punctuation Unicode block (U+3000-U+303F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CjkUnifiedIdeographs">
<summary>Gets the CJK Unified Ideographs Unicode block (U+4E00-U+9FCC).</summary>
<returns>The CJK Unified Ideographs Unicode block (U+4E00-U+9FCC).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CjkUnifiedIdeographsExtensionA">
<summary>Gets the CJK Unitied Ideographs Extension A Unicode block (U+3400-U+4DB5).</summary>
<returns>The CJK Unitied Ideographs Extension A Unicode block (U+3400-U+4DB5).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CombiningDiacriticalMarks">
<summary>Gets the Combining Diacritical Marks Unicode block (U+0300-U+036F).</summary>
<returns>The Combining Diacritical Marks Unicode block (U+0300-U+036F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CombiningDiacriticalMarksExtended">
<summary>Gets the Combining Diacritical Marks Extended Unicode block (U+1AB0-U+1AFF).</summary>
<returns>The Combining Diacritical Marks Extended Unicode block (U+1AB0-U+1AFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CombiningDiacriticalMarksforSymbols">
<summary>Gets the Combining Diacritical Marks for Symbols Unicode block (U+20D0-U+20FF).</summary>
<returns>The Combining Diacritical Marks for Symbols Unicode block (U+20D0-U+20FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CombiningDiacriticalMarksSupplement">
<summary>Gets the Combining Diacritical Marks Supplement Unicode block (U+1DC0-U+1DFF).</summary>
<returns>The Combining Diacritical Marks Supplement Unicode block (U+1DC0-U+1DFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CombiningHalfMarks">
<summary>Gets the Combining Half Marks Unicode block (U+FE20-U+FE2F).</summary>
<returns>The Combining Half Marks Unicode block (U+FE20-U+FE2F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CommonIndicNumberForms">
<summary>Gets the Common Indic Number Forms Unicode block (U+A830-U+A83F).</summary>
<returns>The Common Indic Number Forms Unicode block (U+A830-U+A83F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.ControlPictures">
<summary>Gets the Control Pictures Unicode block (U+2400-U+243F).</summary>
<returns>The Control Pictures Unicode block (U+2400-U+243F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Coptic">
<summary>Gets the Coptic Unicode block (U+2C80-U+2CFF).</summary>
<returns>The Coptic Unicode block (U+2C80-U+2CFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CurrencySymbols">
<summary>Gets the Currency Symbols Unicode block (U+20A0-U+20CF).</summary>
<returns>The Currency Symbols Unicode block (U+20A0-U+20CF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Cyrillic">
<summary>Gets the Cyrillic Unicode block (U+0400-U+04FF).</summary>
<returns>The Cyrillic Unicode block (U+0400-U+04FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CyrillicExtendedA">
<summary>Gets the Cyrillic Extended-A Unicode block (U+2DE0-U+2DFF).</summary>
<returns>The Cyrillic Extended-A Unicode block (U+2DE0-U+2DFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CyrillicExtendedB">
<summary>Gets the Cyrillic Extended-B Unicode block (U+A640-U+A69F).</summary>
<returns>The Cyrillic Extended-B Unicode block (U+A640-U+A69F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CyrillicExtendedC">
<summary>A <see cref="T:System.Text.Unicode.UnicodeRange" /> corresponding to the 'Cyrillic Extended-C' Unicode block (U+1C80..U+1C8F).</summary>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CyrillicSupplement">
<summary>Gets the Cyrillic Supplement Unicode block (U+0500-U+052F).</summary>
<returns>The Cyrillic Supplement Unicode block (U+0500-U+052F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Devanagari">
<summary>Gets the Devangari Unicode block (U+0900-U+097F).</summary>
<returns>The Devangari Unicode block (U+0900-U+097F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.DevanagariExtended">
<summary>Gets the Devanagari Extended Unicode block (U+A8E0-U+A8FF).</summary>
<returns>The Devanagari Extended Unicode block (U+A8E0-U+A8FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Dingbats">
<summary>Gets the Dingbats Unicode block (U+2700-U+27BF).</summary>
<returns>The Dingbats Unicode block (U+2700-U+27BF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.EnclosedAlphanumerics">
<summary>Gets the Enclosed Alphanumerics Unicode block (U+2460-U+24FF).</summary>
<returns>The Enclosed Alphanumerics Unicode block (U+2460-U+24FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.EnclosedCjkLettersandMonths">
<summary>Gets the Enclosed CJK Letters and Months Unicode block (U+3200-U+32FF).</summary>
<returns>The Enclosed CJK Letters and Months Unicode block (U+3200-U+32FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Ethiopic">
<summary>Gets the Ethiopic Unicode block (U+1200-U+137C).</summary>
<returns>The Ethiopic Unicode block (U+1200-U+137C).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.EthiopicExtended">
<summary>Gets the Ethipic Extended Unicode block (U+2D80-U+2DDF).</summary>
<returns>The Ethipic Extended Unicode block (U+2D80-U+2DDF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.EthiopicExtendedA">
<summary>Gets the Ethiopic Extended-A Unicode block (U+AB00-U+AB2F).</summary>
<returns>The Ethiopic Extended-A Unicode block (U+AB00-U+AB2F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.EthiopicSupplement">
<summary>Gets the Ethiopic Supplement Unicode block (U+1380-U+1399).</summary>
<returns>The Ethiopic Supplement Unicode block (U+1380-U+1399).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.GeneralPunctuation">
<summary>Gets the General Punctuation Unicode block (U+2000-U+206F).</summary>
<returns>The General Punctuation Unicode block (U+2000-U+206F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.GeometricShapes">
<summary>Gets the Geometric Shapes Unicode block (U+25A0-U+25FF).</summary>
<returns>The Geometric Shapes Unicode block (U+25A0-U+25FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Georgian">
<summary>Gets the Georgian Unicode block (U+10A0-U+10FF).</summary>
<returns>The Georgian Unicode block (U+10A0-U+10FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.GeorgianExtended">
<summary>A <see cref="T:System.Text.Unicode.UnicodeRange" /> corresponding to the 'Georgian Extended' Unicode block (U+1C90..U+1CBF).</summary>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.GeorgianSupplement">
<summary>Gets the Georgian Supplement Unicode block (U+2D00-U+2D2F).</summary>
<returns>The Georgian Supplement Unicode block (U+2D00-U+2D2F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Glagolitic">
<summary>Gets the Glagolitic Unicode block (U+2C00-U+2C5F).</summary>
<returns>The Glagolitic Unicode block (U+2C00-U+2C5F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.GreekandCoptic">
<summary>Gets the Greek and Coptic Unicode block (U+0370-U+03FF).</summary>
<returns>The Greek and Coptic Unicode block (U+0370-U+03FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.GreekExtended">
<summary>Gets the Greek Extended Unicode block (U+1F00-U+1FFF).</summary>
<returns>The Greek Extended Unicode block (U+1F00-U+1FFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Gujarati">
<summary>Gets the Gujarti Unicode block (U+0A81-U+0AFF).</summary>
<returns>The Gujarti Unicode block (U+0A81-U+0AFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Gurmukhi">
<summary>Gets the Gurmukhi Unicode block (U+0A01-U+0A7F).</summary>
<returns>The Gurmukhi Unicode block (U+0A01-U+0A7F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.HalfwidthandFullwidthForms">
<summary>Gets the Halfwidth and Fullwidth Forms Unicode block (U+FF00-U+FFEE).</summary>
<returns>The Halfwidth and Fullwidth Forms Unicode block (U+FF00-U+FFEE).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.HangulCompatibilityJamo">
<summary>Gets the Hangul Compatibility Jamo Unicode block (U+3131-U+318F).</summary>
<returns>The Hangul Compatibility Jamo Unicode block (U+3131-U+318F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.HangulJamo">
<summary>Gets the Hangul Jamo Unicode block (U+1100-U+11FF).</summary>
<returns>The Hangul Jamo Unicode block (U+1100-U+11FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.HangulJamoExtendedA">
<summary>Gets the Hangul Jamo Extended-A Unicode block (U+A960-U+A9F).</summary>
<returns>The Hangul Jamo Extended-A Unicode block (U+A960-U+A97F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.HangulJamoExtendedB">
<summary>Gets the Hangul Jamo Extended-B Unicode block (U+D7B0-U+D7FF).</summary>
<returns>The Hangul Jamo Extended-B Unicode block (U+D7B0-U+D7FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.HangulSyllables">
<summary>Gets the Hangul Syllables Unicode block (U+AC00-U+D7AF).</summary>
<returns>The Hangul Syllables Unicode block (U+AC00-U+D7AF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Hanunoo">
<summary>Gets the Hanunoo Unicode block (U+1720-U+173F).</summary>
<returns>The Hanunoo Unicode block (U+1720-U+173F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Hebrew">
<summary>Gets the Hebrew Unicode block (U+0590-U+05FF).</summary>
<returns>The Hebrew Unicode block (U+0590-U+05FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Hiragana">
<summary>Gets the Hiragana Unicode block (U+3040-U+309F).</summary>
<returns>The Hiragana Unicode block (U+3040-U+309F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.IdeographicDescriptionCharacters">
<summary>Gets the Ideographic Description Characters Unicode block (U+2FF0-U+2FFF).</summary>
<returns>The Ideographic Description Characters Unicode block (U+2FF0-U+2FFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.IpaExtensions">
<summary>Gets the IPA Extensions Unicode block (U+0250-U+02AF).</summary>
<returns>The IPA Extensions Unicode block (U+0250-U+02AF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Javanese">
<summary>Gets the Javanese Unicode block (U+A980-U+A9DF).</summary>
<returns>The Javanese Unicode block (U+A980-U+A9DF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Kanbun">
<summary>Gets the Kanbun Unicode block (U+3190-U+319F).</summary>
<returns>The Kanbun Unicode block (U+3190-U+319F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.KangxiRadicals">
<summary>Gets the Kangxi Radicals Supplement Unicode block (U+2F00-U+2FDF).</summary>
<returns>The Kangxi Radicals Supplement Unicode block (U+2F00-U+2FDF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Kannada">
<summary>Gets the Kannada Unicode block (U+0C81-U+0CFF).</summary>
<returns>The Kannada Unicode block (U+0C81-U+0CFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Katakana">
<summary>Gets the Katakana Unicode block (U+30A0-U+30FF).</summary>
<returns>The Katakana Unicode block (U+30A0-U+30FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.KatakanaPhoneticExtensions">
<summary>Gets the Katakana Phonetic Extensions Unicode block (U+31F0-U+31FF).</summary>
<returns>The Katakana Phonetic Extensions Unicode block (U+31F0-U+31FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.KayahLi">
<summary>Gets the Kayah Li Unicode block (U+A900-U+A92F).</summary>
<returns>The Kayah Li Unicode block (U+A900-U+A92F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Khmer">
<summary>Gets the Khmer Unicode block (U+1780-U+17FF).</summary>
<returns>The Khmer Unicode block (U+1780-U+17FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.KhmerSymbols">
<summary>Gets the Khmer Symbols Unicode block (U+19E0-U+19FF).</summary>
<returns>The Khmer Symbols Unicode block (U+19E0-U+19FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Lao">
<summary>Gets the Lao Unicode block (U+0E80-U+0EDF).</summary>
<returns>The Lao Unicode block (U+0E80-U+0EDF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Latin1Supplement">
<summary>Gets the Latin-1 Supplement Unicode block (U+00A1-U+00FF).</summary>
<returns>The Latin-1 Supplement Unicode block (U+00A1-U+00FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.LatinExtendedA">
<summary>Gets the Latin Extended-A Unicode block (U+0100-U+017F).</summary>
<returns>The Latin Extended-A Unicode block (U+0100-U+017F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.LatinExtendedAdditional">
<summary>Gets the Latin Extended Additional Unicode block (U+1E00-U+1EFF).</summary>
<returns>The Latin Extended Additional Unicode block (U+1E00-U+1EFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.LatinExtendedB">
<summary>Gets the Latin Extended-B Unicode block (U+0180-U+024F).</summary>
<returns>The Latin Extended-B Unicode block (U+0180-U+024F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.LatinExtendedC">
<summary>Gets the Latin Extended-C Unicode block (U+2C60-U+2C7F).</summary>
<returns>The Latin Extended-C Unicode block (U+2C60-U+2C7F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.LatinExtendedD">
<summary>Gets the Latin Extended-D Unicode block (U+A720-U+A7FF).</summary>
<returns>The Latin Extended-D Unicode block (U+A720-U+A7FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.LatinExtendedE">
<summary>Gets the Latin Extended-E Unicode block (U+AB30-U+AB6F).</summary>
<returns>The Latin Extended-E Unicode block (U+AB30-U+AB6F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Lepcha">
<summary>Gets the Lepcha Unicode block (U+1C00-U+1C4F).</summary>
<returns>The Lepcha Unicode block (U+1C00-U+1C4F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.LetterlikeSymbols">
<summary>Gets the Letterlike Symbols Unicode block (U+2100-U+214F).</summary>
<returns>The Letterlike Symbols Unicode block (U+2100-U+214F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Limbu">
<summary>Gets the Limbu Unicode block (U+1900-U+194F).</summary>
<returns>The Limbu Unicode block (U+1900-U+194F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Lisu">
<summary>Gets the Lisu Unicode block (U+A4D0-U+A4FF).</summary>
<returns>The Lisu Unicode block (U+A4D0-U+A4FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Malayalam">
<summary>Gets the Malayalam Unicode block (U+0D00-U+0D7F).</summary>
<returns>The Malayalam Unicode block (U+0D00-U+0D7F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Mandaic">
<summary>Gets the Mandaic Unicode block (U+0840-U+085F).</summary>
<returns>The Mandaic Unicode block (U+0840-U+085F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.MathematicalOperators">
<summary>Gets the Mathematical Operators Unicode block (U+2200-U+22FF).</summary>
<returns>The Mathematical Operators Unicode block (U+2200-U+22FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.MeeteiMayek">
<summary>Gets the Meetei Mayek Unicode block (U+ABC0-U+ABFF).</summary>
<returns>The Meetei Mayek Unicode block (U+ABC0-U+ABFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.MeeteiMayekExtensions">
<summary>Gets the Meetei Mayek Extensions Unicode block (U+AAE0-U+AAFF).</summary>
<returns>The Meetei Mayek Extensions Unicode block (U+AAE0-U+AAFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.MiscellaneousMathematicalSymbolsA">
<summary>Gets the Miscellaneous Mathematical Symbols-A Unicode block (U+27C0-U+27EF).</summary>
<returns>The Miscellaneous Mathematical Symbols-A Unicode block (U+27C0-U+27EF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.MiscellaneousMathematicalSymbolsB">
<summary>Gets the Miscellaneous Mathematical Symbols-B Unicode block (U+2980-U+29FF).</summary>
<returns>The Miscellaneous Mathematical Symbols-B Unicode block (U+2980-U+29FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.MiscellaneousSymbols">
<summary>Gets the Miscellaneous Symbols Unicode block (U+2600-U+26FF).</summary>
<returns>The Miscellaneous Symbols Unicode block (U+2600-U+26FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.MiscellaneousSymbolsandArrows">
<summary>Gets the Miscellaneous Symbols and Arrows Unicode block (U+2B00-U+2BFF).</summary>
<returns>The Miscellaneous Symbols and Arrows Unicode block (U+2B00-U+2BFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.MiscellaneousTechnical">
<summary>Gets the Miscellaneous Technical Unicode block (U+2300-U+23FF).</summary>
<returns>The Miscellaneous Technical Unicode block (U+2300-U+23FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.ModifierToneLetters">
<summary>Gets the Modifier Tone Letters Unicode block (U+A700-U+A71F).</summary>
<returns>The Modifier Tone Letters Unicode block (U+A700-U+A71F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Mongolian">
<summary>Gets the Mongolian Unicode block (U+1800-U+18AF).</summary>
<returns>The Mongolian Unicode block (U+1800-U+18AF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Myanmar">
<summary>Gets the Myanmar Unicode block (U+1000-U+109F).</summary>
<returns>The Myanmar Unicode block (U+1000-U+109F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.MyanmarExtendedA">
<summary>Gets the Myanmar Extended-A Unicode block (U+AA60-U+AA7F).</summary>
<returns>The Myanmar Extended-A Unicode block (U+AA60-U+AA7F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.MyanmarExtendedB">
<summary>Gets the Myanmar Extended-B Unicode block (U+A9E0-U+A9FF).</summary>
<returns>The Myanmar Extended-B Unicode block (U+A9E0-U+A9FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.NewTaiLue">
<summary>Gets the New Tai Lue Unicode block (U+1980-U+19DF).</summary>
<returns>The New Tai Lue Unicode block (U+1980-U+19DF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.NKo">
<summary>Gets the NKo Unicode block (U+07C0-U+07FF).</summary>
<returns>The NKo Unicode block (U+07C0-U+07FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.None">
<summary>Gets an empty Unicode range.</summary>
<returns>A Unicode range with no elements.</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.NumberForms">
<summary>Gets the Number Forms Unicode block (U+2150-U+218F).</summary>
<returns>The Number Forms Unicode block (U+2150-U+218F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Ogham">
<summary>Gets the Ogham Unicode block (U+1680-U+169F).</summary>
<returns>The Ogham Unicode block (U+1680-U+169F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.OlChiki">
<summary>Gets the Ol Chiki Unicode block (U+1C50-U+1C7F).</summary>
<returns>The Ol Chiki Unicode block (U+1C50-U+1C7F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.OpticalCharacterRecognition">
<summary>Gets the Optical Character Recognition Unicode block (U+2440-U+245F).</summary>
<returns>The Optical Character Recognition Unicode block (U+2440-U+245F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Oriya">
<summary>Gets the Oriya Unicode block (U+0B00-U+0B7F).</summary>
<returns>The Oriya Unicode block (U+0B00-U+0B7F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Phagspa">
<summary>Gets the Phags-pa Unicode block (U+A840-U+A87F).</summary>
<returns>The Phags-pa Unicode block (U+A840-U+A87F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.PhoneticExtensions">
<summary>Gets the Phonetic Extensions Unicode block (U+1D00-U+1D7F).</summary>
<returns>The Phonetic Extensions Unicode block (U+1D00-U+1D7F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.PhoneticExtensionsSupplement">
<summary>Gets the Phonetic Extensions Supplement Unicode block (U+1D80-U+1DBF).</summary>
<returns>The Phonetic Extensions Supplement Unicode block (U+1D80-U+1DBF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Rejang">
<summary>Gets the Rejang Unicode block (U+A930-U+A95F).</summary>
<returns>The Rejang Unicode block (U+A930-U+A95F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Runic">
<summary>Gets the Runic Unicode block (U+16A0-U+16FF).</summary>
<returns>The Runic Unicode block (U+16A0-U+16FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Samaritan">
<summary>Gets the Samaritan Unicode block (U+0800-U+083F).</summary>
<returns>The Samaritan Unicode block (U+0800-U+083F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Saurashtra">
<summary>Gets the Saurashtra Unicode block (U+A880-U+A8DF).</summary>
<returns>The Saurashtra Unicode block (U+A880-U+A8DF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Sinhala">
<summary>Gets the Sinhala Unicode block (U+0D80-U+0DFF).</summary>
<returns>The Sinhala Unicode block (U+0D80-U+0DFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.SmallFormVariants">
<summary>Gets the Small Form Variants Unicode block (U+FE50-U+FE6F).</summary>
<returns>The Small Form Variants Unicode block (U+FE50-U+FE6F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.SpacingModifierLetters">
<summary>Gets the Spacing Modifier Letters Unicode block (U+02B0-U+02FF).</summary>
<returns>The Spacing Modifier Letters Unicode block (U+02B0-U+02FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Specials">
<summary>Gets the Specials Unicode block (U+FFF0-U+FFFF).</summary>
<returns>The Specials Unicode block (U+FFF0-U+FFFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Sundanese">
<summary>Gets the Sundanese Unicode block (U+1B80-U+1BBF).</summary>
<returns>The Sundanese Unicode block (U+1B80-U+1BBF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.SundaneseSupplement">
<summary>Gets the Sundanese Supplement Unicode block (U+1CC0-U+1CCF).</summary>
<returns>The Sundanese Supplement Unicode block (U+1CC0-U+1CCF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.SuperscriptsandSubscripts">
<summary>Gets the Superscripts and Subscripts Unicode block (U+2070-U+209F).</summary>
<returns>The Superscripts and Subscripts Unicode block (U+2070-U+209F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.SupplementalArrowsA">
<summary>Gets the Supplemental Arrows-A Unicode block (U+27F0-U+27FF).</summary>
<returns>The Supplemental Arrows-A Unicode block (U+27F0-U+27FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.SupplementalArrowsB">
<summary>Gets the Supplemental Arrows-B Unicode block (U+2900-U+297F).</summary>
<returns>The Supplemental Arrows-B Unicode block (U+2900-U+297F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.SupplementalMathematicalOperators">
<summary>Gets the Supplemental Mathematical Operators Unicode block (U+2A00-U+2AFF).</summary>
<returns>The Supplemental Mathematical Operators Unicode block (U+2A00-U+2AFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.SupplementalPunctuation">
<summary>Gets the Supplemental Punctuation Unicode block (U+2E00-U+2E7F).</summary>
<returns>The Supplemental Punctuation Unicode block (U+2E00-U+2E7F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.SylotiNagri">
<summary>Gets the Syloti Nagri Unicode block (U+A800-U+A82F).</summary>
<returns>The Syloti Nagri Unicode block (U+A800-U+A82F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Syriac">
<summary>Gets the Syriac Unicode block (U+0700-U+074F).</summary>
<returns>The Syriac Unicode block (U+0700-U+074F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.SyriacSupplement">
<summary>A <see cref="T:System.Text.Unicode.UnicodeRange" /> corresponding to the 'Syriac Supplement' Unicode block (U+0860..U+086F).</summary>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Tagalog">
<summary>Gets the Tagalog Unicode block (U+1700-U+171F).</summary>
<returns>The Tagalog Unicode block (U+1700-U+171F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Tagbanwa">
<summary>Gets the Tagbanwa Unicode block (U+1760-U+177F).</summary>
<returns>The Tagbanwa Unicode block (U+1760-U+177F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.TaiLe">
<summary>Gets the Tai Le Unicode block (U+1950-U+197F).</summary>
<returns>The Tai Le Unicode block (U+1950-U+197F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.TaiTham">
<summary>Gets the Tai Tham Unicode block (U+1A20-U+1AAF).</summary>
<returns>The Tai Tham Unicode block (U+1A20-U+1AAF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.TaiViet">
<summary>Gets the Tai Viet Unicode block (U+AA80-U+AADF).</summary>
<returns>The Tai Viet Unicode block (U+AA80-U+AADF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Tamil">
<summary>Gets the Tamil Unicode block (U+0B80-U+0BFF).</summary>
<returns>The Tamil Unicode block (U+0B82-U+0BFA).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Telugu">
<summary>Gets the Telugu Unicode block (U+0C00-U+0C7F).</summary>
<returns>The Telugu Unicode block (U+0C00-U+0C7F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Thaana">
<summary>Gets the Thaana Unicode block (U+0780-U+07BF).</summary>
<returns>The Thaana Unicode block (U+0780-U+07BF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Thai">
<summary>Gets the Thai Unicode block (U+0E00-U+0E7F).</summary>
<returns>The Thai Unicode block (U+0E00-U+0E7F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Tibetan">
<summary>Gets the Tibetan Unicode block (U+0F00-U+0FFF).</summary>
<returns>The Tibetan Unicode block (U+0F00-U+0FFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Tifinagh">
<summary>Gets the Tifinagh Unicode block (U+2D30-U+2D7F).</summary>
<returns>The Tifinagh Unicode block (U+2D30-U+2D7F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.UnifiedCanadianAboriginalSyllabics">
<summary>Gets the Unified Canadian Aboriginal Syllabics Unicode block (U+1400-U+167F).</summary>
<returns>The Unified Canadian Aboriginal Syllabics Unicode block (U+1400-U+167F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.UnifiedCanadianAboriginalSyllabicsExtended">
<summary>Gets the Unified Canadian Aboriginal Syllabics Extended Unicode block (U+18B0-U+18FF).</summary>
<returns>The Unified Canadian Aboriginal Syllabics Extended Unicode block (U+18B0-U+18FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Vai">
<summary>Gets the Vai Unicode block (U+A500-U+A63F).</summary>
<returns>The Vai Unicode block (U+A500-U+A63F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.VariationSelectors">
<summary>Gets the Variation Selectors Unicode block (U+FE00-U+FE0F).</summary>
<returns>The Variation Selectors Unicode block (U+FE00-U+FE0F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.VedicExtensions">
<summary>Gets the Vedic Extensions Unicode block (U+1CD0-U+1CFF).</summary>
<returns>The Vedic Extensions Unicode block (U+1CD0-U+1CFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.VerticalForms">
<summary>Gets the Vertical Forms Unicode block (U+FE10-U+FE1F).</summary>
<returns>The Vertical Forms Unicode block (U+FE10-U+FE1F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.YijingHexagramSymbols">
<summary>Gets the Yijing Hexagram Symbols Unicode block (U+4DC0-U+4DFF).</summary>
<returns>The Yijing Hexagram Symbols Unicode block (U+4DC0-U+4DFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.YiRadicals">
<summary>Gets the Yi Radicals Unicode block (U+A490-U+A4CF).</summary>
<returns>The Yi Radicals Unicode block (U+A490-U+A4CF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.YiSyllables">
<summary>Gets the Yi Syllables Unicode block (U+A000-U+A48F).</summary>
<returns>The Yi Syllables Unicode block (U+A000-U+A48F).</returns>
</member>
</members>
</doc>

View File

@@ -0,0 +1,939 @@
<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>System.Text.Encodings.Web</name>
</assembly>
<members>
<member name="T:System.Text.Encodings.Web.HtmlEncoder">
<summary>Represents an HTML character encoding.</summary>
</member>
<member name="M:System.Text.Encodings.Web.HtmlEncoder.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> class.</summary>
</member>
<member name="M:System.Text.Encodings.Web.HtmlEncoder.Create(System.Text.Encodings.Web.TextEncoderSettings)">
<summary>Creates a new instance of the HtmlEncoder class with the specified settings.</summary>
<param name="settings">Settings that control how the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> instance encodes, primarily which characters to encode.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="settings" /> is <see langword="null" />.</exception>
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> class.</returns>
</member>
<member name="M:System.Text.Encodings.Web.HtmlEncoder.Create(System.Text.Unicode.UnicodeRange[])">
<summary>Creates a new instance of the HtmlEncoder class that specifies characters the encoder is allowed to not encode.</summary>
<param name="allowedRanges">The set of characters that the encoder is allowed to not encode.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="allowedRanges" /> is <see langword="null" />.</exception>
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> class.</returns>
</member>
<member name="P:System.Text.Encodings.Web.HtmlEncoder.Default">
<summary>Gets a built-in instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> class.</summary>
<returns>A built-in instance of the <see cref="T:System.Text.Encodings.Web.HtmlEncoder" /> class.</returns>
</member>
<member name="T:System.Text.Encodings.Web.JavaScriptEncoder">
<summary>Represents a JavaScript character encoding.</summary>
</member>
<member name="M:System.Text.Encodings.Web.JavaScriptEncoder.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</summary>
</member>
<member name="M:System.Text.Encodings.Web.JavaScriptEncoder.Create(System.Text.Encodings.Web.TextEncoderSettings)">
<summary>Creates a new instance of JavaScriptEncoder class with the specified settings.</summary>
<param name="settings">Settings that control how the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> instance encodes, primarily which characters to encode.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="settings" /> is <see langword="null" />.</exception>
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</returns>
</member>
<member name="M:System.Text.Encodings.Web.JavaScriptEncoder.Create(System.Text.Unicode.UnicodeRange[])">
<summary>Creates a new instance of the JavaScriptEncoder class that specifies characters the encoder is allowed to not encode.</summary>
<param name="allowedRanges">The set of characters that the encoder is allowed to not encode.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="allowedRanges" /> is <see langword="null" />.</exception>
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</returns>
</member>
<member name="P:System.Text.Encodings.Web.JavaScriptEncoder.Default">
<summary>Gets a built-in instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</summary>
<returns>A built-in instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</returns>
</member>
<member name="P:System.Text.Encodings.Web.JavaScriptEncoder.UnsafeRelaxedJsonEscaping">
<summary>Gets a built-in JavaScript encoder instance that is less strict about what is encoded.</summary>
<returns>A JavaScript encoder instance.</returns>
</member>
<member name="T:System.Text.Encodings.Web.TextEncoder">
<summary>The base class of web encoders.</summary>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.TextEncoder" /> class.</summary>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.IO.TextWriter,System.Char[],System.Int32,System.Int32)">
<summary>Encodes characters from an array and writes them to a <see cref="T:System.IO.TextWriter" /> object.</summary>
<param name="output">The stream to which to write the encoded text.</param>
<param name="value">The array of characters to encode.</param>
<param name="startIndex">The array index of the first character to encode.</param>
<param name="characterCount">The number of characters in the array to encode.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="output" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="M:System.Text.Encodings.Web.TextEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)" /> method failed. The encoder does not implement <see cref="P:System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter" /> correctly.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="value" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="startIndex" /> is out of range.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="characterCount" /> is out of range.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.IO.TextWriter,System.String,System.Int32,System.Int32)">
<summary>Encodes a substring and writes it to a <see cref="T:System.IO.TextWriter" /> object.</summary>
<param name="output">The stream to which to write the encoded text.</param>
<param name="value">The string whose substring is to be encoded.</param>
<param name="startIndex">The index where the substring starts.</param>
<param name="characterCount">The number of characters in the substring.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="output" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="M:System.Text.Encodings.Web.TextEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)" /> method failed. The encoder does not implement <see cref="P:System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter" /> correctly.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="value" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="startIndex" /> is out of range.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="characterCount" /> is out of range.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.IO.TextWriter,System.String)">
<summary>Encodes the specified string to a <see cref="T:System.IO.TextWriter" /> object.</summary>
<param name="output">The stream to which to write the encoded text.</param>
<param name="value">The string to encode.</param>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.ReadOnlySpan{System.Char},System.Span{System.Char},System.Int32@,System.Int32@,System.Boolean)">
<summary>Encodes the supplied characters.</summary>
<param name="source">A source buffer containing the characters to encode.</param>
<param name="destination">The destination buffer to which the encoded form of <paramref name="source" /> will be written.</param>
<param name="charsConsumed">The number of characters consumed from the <paramref name="source" /> buffer.</param>
<param name="charsWritten">The number of characters written to the <paramref name="destination" /> buffer.</param>
<param name="isFinalBlock">
<see langword="true" /> to indicate there is no further source data that needs to be encoded; otherwise, <see langword="false" />.</param>
<returns>An enumeration value that describes the result of the encoding operation.</returns>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.Encode(System.String)">
<summary>Encodes the supplied string and returns the encoded text as a new string.</summary>
<param name="value">The string to encode.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="value" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="M:System.Text.Encodings.Web.TextEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)" /> method failed. The encoder does not implement <see cref="P:System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter" /> correctly.</exception>
<returns>The encoded string.</returns>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.EncodeUtf8(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@,System.Int32@,System.Boolean)">
<summary>Encodes the supplied UTF-8 text.</summary>
<param name="utf8Source">A source buffer containing the UTF-8 text to encode.</param>
<param name="utf8Destination">The destination buffer to which the encoded form of <paramref name="utf8Source" /> will be written.</param>
<param name="bytesConsumed">The number of bytes consumed from the <paramref name="utf8Source" /> buffer.</param>
<param name="bytesWritten">The number of bytes written to the <paramref name="utf8Destination" /> buffer.</param>
<param name="isFinalBlock">
<see langword="true" /> to indicate there is no further source data that needs to be encoded; otherwise, <see langword="false" />.</param>
<returns>A status code that describes the result of the encoding operation.</returns>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.FindFirstCharacterToEncode(System.Char*,System.Int32)">
<summary>Finds the index of the first character to encode.</summary>
<param name="text">The text buffer to search.</param>
<param name="textLength">The number of characters in <paramref name="text" />.</param>
<returns>The index of the first character to encode.</returns>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.FindFirstCharacterToEncodeUtf8(System.ReadOnlySpan{System.Byte})">
<summary>Finds the first element in a UTF-8 text input buffer that would be escaped by the current encoder instance.</summary>
<param name="utf8Text">The UTF-8 text input buffer to search.</param>
<returns>The index of the first element in <paramref name="utf8Text" /> that would be escaped by the current encoder instance, or -1 if no data in <paramref name="utf8Text" /> requires escaping.</returns>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)">
<summary>Encodes a Unicode scalar value and writes it to a buffer.</summary>
<param name="unicodeScalar">A Unicode scalar value.</param>
<param name="buffer">A pointer to the buffer to which to write the encoded text.</param>
<param name="bufferLength">The length of the destination <paramref name="buffer" /> in characters.</param>
<param name="numberOfCharactersWritten">When the method returns, indicates the number of characters written to the <paramref name="buffer" />.</param>
<returns>
<see langword="false" /> if <paramref name="bufferLength" /> is too small to fit the encoded text; otherwise, returns <see langword="true" />.</returns>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoder.WillEncode(System.Int32)">
<summary>Determines if a given Unicode scalar value will be encoded.</summary>
<param name="unicodeScalar">A Unicode scalar value.</param>
<returns>
<see langword="true" /> if the <paramref name="unicodeScalar" /> value will be encoded by this encoder; otherwise, returns <see langword="false" />.</returns>
</member>
<member name="P:System.Text.Encodings.Web.TextEncoder.MaxOutputCharactersPerInputCharacter">
<summary>Gets the maximum number of characters that this encoder can generate for each input code point.</summary>
<returns>The maximum number of characters.</returns>
</member>
<member name="T:System.Text.Encodings.Web.TextEncoderSettings">
<summary>Represents a filter that allows only certain Unicode code points.</summary>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.#ctor">
<summary>Instantiates an empty filter (allows no code points through by default).</summary>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.#ctor(System.Text.Encodings.Web.TextEncoderSettings)">
<summary>Instantiates a filter by cloning the allowed list of another <see cref="T:System.Text.Encodings.Web.TextEncoderSettings" /> object.</summary>
<param name="other">The other <see cref="T:System.Text.Encodings.Web.TextEncoderSettings" /> object to be cloned.</param>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.#ctor(System.Text.Unicode.UnicodeRange[])">
<summary>Instantiates a filter where only the character ranges specified by <paramref name="allowedRanges" /> are allowed by the filter.</summary>
<param name="allowedRanges">The allowed character ranges.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="allowedRanges" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.AllowCharacter(System.Char)">
<summary>Allows the character specified by <paramref name="character" /> through the filter.</summary>
<param name="character">The allowed character.</param>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.AllowCharacters(System.Char[])">
<summary>Allows all characters specified by <paramref name="characters" /> through the filter.</summary>
<param name="characters">The allowed characters.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="characters" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.AllowCodePoints(System.Collections.Generic.IEnumerable{System.Int32})">
<summary>Allows all code points specified by <paramref name="codePoints" />.</summary>
<param name="codePoints">The allowed code points.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="codePoints" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.AllowRange(System.Text.Unicode.UnicodeRange)">
<summary>Allows all characters specified by <paramref name="range" /> through the filter.</summary>
<param name="range">The range of characters to be allowed.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="range" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.AllowRanges(System.Text.Unicode.UnicodeRange[])">
<summary>Allows all characters specified by <paramref name="ranges" /> through the filter.</summary>
<param name="ranges">The ranges of characters to be allowed.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="ranges" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.Clear">
<summary>Resets this object by disallowing all characters.</summary>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.ForbidCharacter(System.Char)">
<summary>Disallows the character <paramref name="character" /> through the filter.</summary>
<param name="character">The disallowed character.</param>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.ForbidCharacters(System.Char[])">
<summary>Disallows all characters specified by <paramref name="characters" /> through the filter.</summary>
<param name="characters">The disallowed characters.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="characters" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.ForbidRange(System.Text.Unicode.UnicodeRange)">
<summary>Disallows all characters specified by <paramref name="range" /> through the filter.</summary>
<param name="range">The range of characters to be disallowed.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="range" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.ForbidRanges(System.Text.Unicode.UnicodeRange[])">
<summary>Disallows all characters specified by <paramref name="ranges" /> through the filter.</summary>
<param name="ranges">The ranges of characters to be disallowed.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="ranges" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Text.Encodings.Web.TextEncoderSettings.GetAllowedCodePoints">
<summary>Gets an enumerator of all allowed code points.</summary>
<returns>The enumerator of allowed code points.</returns>
</member>
<member name="T:System.Text.Encodings.Web.UrlEncoder">
<summary>Represents a URL character encoding.</summary>
</member>
<member name="M:System.Text.Encodings.Web.UrlEncoder.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> class.</summary>
</member>
<member name="M:System.Text.Encodings.Web.UrlEncoder.Create(System.Text.Encodings.Web.TextEncoderSettings)">
<summary>Creates a new instance of UrlEncoder class with the specified settings.</summary>
<param name="settings">Settings that control how the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> instance encodes, primarily which characters to encode.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="settings" /> is <see langword="null" />.</exception>
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> class.</returns>
</member>
<member name="M:System.Text.Encodings.Web.UrlEncoder.Create(System.Text.Unicode.UnicodeRange[])">
<summary>Creates a new instance of the UrlEncoder class that specifies characters the encoder is allowed to not encode.</summary>
<param name="allowedRanges">The set of characters that the encoder is allowed to not encode.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="allowedRanges" /> is <see langword="null" />.</exception>
<returns>A new instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> class.</returns>
</member>
<member name="P:System.Text.Encodings.Web.UrlEncoder.Default">
<summary>Gets a built-in instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> class.</summary>
<returns>A built-in instance of the <see cref="T:System.Text.Encodings.Web.UrlEncoder" /> class.</returns>
</member>
<member name="T:System.Text.Unicode.UnicodeRange">
<summary>Represents a contiguous range of Unicode code points.</summary>
</member>
<member name="M:System.Text.Unicode.UnicodeRange.#ctor(System.Int32,System.Int32)">
<summary>Creates a new <see cref="T:System.Text.Unicode.UnicodeRange" /> that includes a specified number of characters starting at a specified Unicode code point.</summary>
<param name="firstCodePoint">The first code point in the range.</param>
<param name="length">The number of code points in the range.</param>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="firstCodePoint" /> is less than zero or greater than 0xFFFF.
-or-
<paramref name="length" /> is less than zero.
-or-
<paramref name="firstCodePoint" /> plus <paramref name="length" /> is greater than 0xFFFF.</exception>
</member>
<member name="M:System.Text.Unicode.UnicodeRange.Create(System.Char,System.Char)">
<summary>Creates a new <see cref="T:System.Text.Unicode.UnicodeRange" /> instance from a span of characters.</summary>
<param name="firstCharacter">The first character in the range.</param>
<param name="lastCharacter">The last character in the range.</param>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="lastCharacter" /> precedes <paramref name="firstCharacter" />.</exception>
<returns>A range that includes all characters between <paramref name="firstCharacter" /> and <paramref name="lastCharacter" />.</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRange.FirstCodePoint">
<summary>Gets the first code point in the range represented by this <see cref="T:System.Text.Unicode.UnicodeRange" /> instance.</summary>
<returns>The first code point in the range.</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRange.Length">
<summary>Gets the number of code points in the range represented by this <see cref="T:System.Text.Unicode.UnicodeRange" /> instance.</summary>
<returns>The number of code points in the range.</returns>
</member>
<member name="T:System.Text.Unicode.UnicodeRanges">
<summary>Provides static properties that return predefined <see cref="T:System.Text.Unicode.UnicodeRange" /> instances that correspond to blocks from the Unicode specification.</summary>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.All">
<summary>Gets a range that consists of the entire Basic Multilingual Plane (BMP), from U+0000 to U+FFFF).</summary>
<returns>A range that consists of the entire BMP.</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.AlphabeticPresentationForms">
<summary>Gets the Alphabetic Presentation Forms Unicode block (U+FB00-U+FB4F).</summary>
<returns>The Alphabetic Presentation Forms Unicode block (U+FB00-U+FB4F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Arabic">
<summary>Gets the Arabic Unicode block (U+0600-U+06FF).</summary>
<returns>The Arabic Unicode block (U+0600-U+06FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.ArabicExtendedA">
<summary>Gets the Arabic Extended-A Unicode block (U+08A0-U+08FF).</summary>
<returns>The Arabic Extended-A Unicode block (U+08A0-U+08FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.ArabicExtendedB">
<summary>A <see cref="T:System.Text.Unicode.UnicodeRange" /> corresponding to the 'Arabic Extended-B' Unicode block (U+0870..U+089F).</summary>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.ArabicPresentationFormsA">
<summary>Gets the Arabic Presentation Forms-A Unicode block (U+FB50-U+FDFF).</summary>
<returns>The Arabic Presentation Forms-A Unicode block (U+FB50-U+FDFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.ArabicPresentationFormsB">
<summary>Gets the Arabic Presentation Forms-B Unicode block (U+FE70-U+FEFF).</summary>
<returns>The Arabic Presentation Forms-B Unicode block (U+FE70-U+FEFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.ArabicSupplement">
<summary>Gets the Arabic Supplement Unicode block (U+0750-U+077F).</summary>
<returns>The Arabic Supplement Unicode block (U+0750-U+077F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Armenian">
<summary>Gets the Armenian Unicode block (U+0530-U+058F).</summary>
<returns>The Armenian Unicode block (U+0530-U+058F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Arrows">
<summary>Gets the Arrows Unicode block (U+2190-U+21FF).</summary>
<returns>The Arrows Unicode block (U+2190-U+21FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Balinese">
<summary>Gets the Balinese Unicode block (U+1B00-U+1B7F).</summary>
<returns>The Balinese Unicode block (U+1B00-U+1B7F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Bamum">
<summary>Gets the Bamum Unicode block (U+A6A0-U+A6FF).</summary>
<returns>The Bamum Unicode block (U+A6A0-U+A6FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.BasicLatin">
<summary>Gets the Basic Latin Unicode block (U+0021-U+007F).</summary>
<returns>The Basic Latin Unicode block (U+0021-U+007F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Batak">
<summary>Gets the Batak Unicode block (U+1BC0-U+1BFF).</summary>
<returns>The Batak Unicode block (U+1BC0-U+1BFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Bengali">
<summary>Gets the Bengali Unicode block (U+0980-U+09FF).</summary>
<returns>The Bengali Unicode block (U+0980-U+09FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.BlockElements">
<summary>Gets the Block Elements Unicode block (U+2580-U+259F).</summary>
<returns>The Block Elements Unicode block (U+2580-U+259F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Bopomofo">
<summary>Gets the Bopomofo Unicode block (U+3100-U+312F).</summary>
<returns>The Bopomofo Unicode block (U+3105-U+312F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.BopomofoExtended">
<summary>Gets the Bopomofo Extended Unicode block (U+31A0-U+31BF).</summary>
<returns>The Bopomofo Extended Unicode block (U+31A0-U+31BF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.BoxDrawing">
<summary>Gets the Box Drawing Unicode block (U+2500-U+257F).</summary>
<returns>The Box Drawing Unicode block (U+2500-U+257F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.BraillePatterns">
<summary>Gets the Braille Patterns Unicode block (U+2800-U+28FF).</summary>
<returns>The Braille Patterns Unicode block (U+2800-U+28FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Buginese">
<summary>Gets the Buginese Unicode block (U+1A00-U+1A1F).</summary>
<returns>The Buginese Unicode block (U+1A00-U+1A1F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Buhid">
<summary>Gets the Buhid Unicode block (U+1740-U+175F).</summary>
<returns>The Buhid Unicode block (U+1740-U+175F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Cham">
<summary>Gets the Cham Unicode block (U+AA00-U+AA5F).</summary>
<returns>The Cham Unicode block (U+AA00-U+AA5F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Cherokee">
<summary>Gets the Cherokee Unicode block (U+13A0-U+13FF).</summary>
<returns>The Cherokee Unicode block (U+13A0-U+13FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CherokeeSupplement">
<summary>Gets the Cherokee Supplement Unicode block (U+AB70-U+ABBF).</summary>
<returns>The Cherokee Supplement Unicode block (U+AB70-U+ABBF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CjkCompatibility">
<summary>Gets the CJK Compatibility Unicode block (U+3300-U+33FF).</summary>
<returns>The CJK Compatibility Unicode block (U+3300-U+33FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CjkCompatibilityForms">
<summary>Gets the CJK Compatibility Forms Unicode block (U+FE30-U+FE4F).</summary>
<returns>The CJK Compatibility Forms Unicode block (U+FE30-U+FE4F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CjkCompatibilityIdeographs">
<summary>Gets the CJK Compatibility Ideographs Unicode block (U+F900-U+FAD9).</summary>
<returns>The CJK Compatibility Ideographs Unicode block (U+F900-U+FAD9).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CjkRadicalsSupplement">
<summary>Gets the CJK Radicals Supplement Unicode block (U+2E80-U+2EFF).</summary>
<returns>The CJK Radicals Supplement Unicode block (U+2E80-U+2EFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CjkStrokes">
<summary>Gets the CJK Strokes Unicode block (U+31C0-U+31EF).</summary>
<returns>The CJK Strokes Unicode block (U+31C0-U+31EF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CjkSymbolsandPunctuation">
<summary>Gets the CJK Symbols and Punctuation Unicode block (U+3000-U+303F).</summary>
<returns>The CJK Symbols and Punctuation Unicode block (U+3000-U+303F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CjkUnifiedIdeographs">
<summary>Gets the CJK Unified Ideographs Unicode block (U+4E00-U+9FCC).</summary>
<returns>The CJK Unified Ideographs Unicode block (U+4E00-U+9FCC).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CjkUnifiedIdeographsExtensionA">
<summary>Gets the CJK Unitied Ideographs Extension A Unicode block (U+3400-U+4DB5).</summary>
<returns>The CJK Unitied Ideographs Extension A Unicode block (U+3400-U+4DB5).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CombiningDiacriticalMarks">
<summary>Gets the Combining Diacritical Marks Unicode block (U+0300-U+036F).</summary>
<returns>The Combining Diacritical Marks Unicode block (U+0300-U+036F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CombiningDiacriticalMarksExtended">
<summary>Gets the Combining Diacritical Marks Extended Unicode block (U+1AB0-U+1AFF).</summary>
<returns>The Combining Diacritical Marks Extended Unicode block (U+1AB0-U+1AFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CombiningDiacriticalMarksforSymbols">
<summary>Gets the Combining Diacritical Marks for Symbols Unicode block (U+20D0-U+20FF).</summary>
<returns>The Combining Diacritical Marks for Symbols Unicode block (U+20D0-U+20FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CombiningDiacriticalMarksSupplement">
<summary>Gets the Combining Diacritical Marks Supplement Unicode block (U+1DC0-U+1DFF).</summary>
<returns>The Combining Diacritical Marks Supplement Unicode block (U+1DC0-U+1DFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CombiningHalfMarks">
<summary>Gets the Combining Half Marks Unicode block (U+FE20-U+FE2F).</summary>
<returns>The Combining Half Marks Unicode block (U+FE20-U+FE2F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CommonIndicNumberForms">
<summary>Gets the Common Indic Number Forms Unicode block (U+A830-U+A83F).</summary>
<returns>The Common Indic Number Forms Unicode block (U+A830-U+A83F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.ControlPictures">
<summary>Gets the Control Pictures Unicode block (U+2400-U+243F).</summary>
<returns>The Control Pictures Unicode block (U+2400-U+243F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Coptic">
<summary>Gets the Coptic Unicode block (U+2C80-U+2CFF).</summary>
<returns>The Coptic Unicode block (U+2C80-U+2CFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CurrencySymbols">
<summary>Gets the Currency Symbols Unicode block (U+20A0-U+20CF).</summary>
<returns>The Currency Symbols Unicode block (U+20A0-U+20CF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Cyrillic">
<summary>Gets the Cyrillic Unicode block (U+0400-U+04FF).</summary>
<returns>The Cyrillic Unicode block (U+0400-U+04FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CyrillicExtendedA">
<summary>Gets the Cyrillic Extended-A Unicode block (U+2DE0-U+2DFF).</summary>
<returns>The Cyrillic Extended-A Unicode block (U+2DE0-U+2DFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CyrillicExtendedB">
<summary>Gets the Cyrillic Extended-B Unicode block (U+A640-U+A69F).</summary>
<returns>The Cyrillic Extended-B Unicode block (U+A640-U+A69F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CyrillicExtendedC">
<summary>A <see cref="T:System.Text.Unicode.UnicodeRange" /> corresponding to the 'Cyrillic Extended-C' Unicode block (U+1C80..U+1C8F).</summary>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.CyrillicSupplement">
<summary>Gets the Cyrillic Supplement Unicode block (U+0500-U+052F).</summary>
<returns>The Cyrillic Supplement Unicode block (U+0500-U+052F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Devanagari">
<summary>Gets the Devangari Unicode block (U+0900-U+097F).</summary>
<returns>The Devangari Unicode block (U+0900-U+097F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.DevanagariExtended">
<summary>Gets the Devanagari Extended Unicode block (U+A8E0-U+A8FF).</summary>
<returns>The Devanagari Extended Unicode block (U+A8E0-U+A8FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Dingbats">
<summary>Gets the Dingbats Unicode block (U+2700-U+27BF).</summary>
<returns>The Dingbats Unicode block (U+2700-U+27BF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.EnclosedAlphanumerics">
<summary>Gets the Enclosed Alphanumerics Unicode block (U+2460-U+24FF).</summary>
<returns>The Enclosed Alphanumerics Unicode block (U+2460-U+24FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.EnclosedCjkLettersandMonths">
<summary>Gets the Enclosed CJK Letters and Months Unicode block (U+3200-U+32FF).</summary>
<returns>The Enclosed CJK Letters and Months Unicode block (U+3200-U+32FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Ethiopic">
<summary>Gets the Ethiopic Unicode block (U+1200-U+137C).</summary>
<returns>The Ethiopic Unicode block (U+1200-U+137C).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.EthiopicExtended">
<summary>Gets the Ethipic Extended Unicode block (U+2D80-U+2DDF).</summary>
<returns>The Ethipic Extended Unicode block (U+2D80-U+2DDF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.EthiopicExtendedA">
<summary>Gets the Ethiopic Extended-A Unicode block (U+AB00-U+AB2F).</summary>
<returns>The Ethiopic Extended-A Unicode block (U+AB00-U+AB2F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.EthiopicSupplement">
<summary>Gets the Ethiopic Supplement Unicode block (U+1380-U+1399).</summary>
<returns>The Ethiopic Supplement Unicode block (U+1380-U+1399).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.GeneralPunctuation">
<summary>Gets the General Punctuation Unicode block (U+2000-U+206F).</summary>
<returns>The General Punctuation Unicode block (U+2000-U+206F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.GeometricShapes">
<summary>Gets the Geometric Shapes Unicode block (U+25A0-U+25FF).</summary>
<returns>The Geometric Shapes Unicode block (U+25A0-U+25FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Georgian">
<summary>Gets the Georgian Unicode block (U+10A0-U+10FF).</summary>
<returns>The Georgian Unicode block (U+10A0-U+10FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.GeorgianExtended">
<summary>A <see cref="T:System.Text.Unicode.UnicodeRange" /> corresponding to the 'Georgian Extended' Unicode block (U+1C90..U+1CBF).</summary>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.GeorgianSupplement">
<summary>Gets the Georgian Supplement Unicode block (U+2D00-U+2D2F).</summary>
<returns>The Georgian Supplement Unicode block (U+2D00-U+2D2F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Glagolitic">
<summary>Gets the Glagolitic Unicode block (U+2C00-U+2C5F).</summary>
<returns>The Glagolitic Unicode block (U+2C00-U+2C5F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.GreekandCoptic">
<summary>Gets the Greek and Coptic Unicode block (U+0370-U+03FF).</summary>
<returns>The Greek and Coptic Unicode block (U+0370-U+03FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.GreekExtended">
<summary>Gets the Greek Extended Unicode block (U+1F00-U+1FFF).</summary>
<returns>The Greek Extended Unicode block (U+1F00-U+1FFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Gujarati">
<summary>Gets the Gujarti Unicode block (U+0A81-U+0AFF).</summary>
<returns>The Gujarti Unicode block (U+0A81-U+0AFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Gurmukhi">
<summary>Gets the Gurmukhi Unicode block (U+0A01-U+0A7F).</summary>
<returns>The Gurmukhi Unicode block (U+0A01-U+0A7F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.HalfwidthandFullwidthForms">
<summary>Gets the Halfwidth and Fullwidth Forms Unicode block (U+FF00-U+FFEE).</summary>
<returns>The Halfwidth and Fullwidth Forms Unicode block (U+FF00-U+FFEE).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.HangulCompatibilityJamo">
<summary>Gets the Hangul Compatibility Jamo Unicode block (U+3131-U+318F).</summary>
<returns>The Hangul Compatibility Jamo Unicode block (U+3131-U+318F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.HangulJamo">
<summary>Gets the Hangul Jamo Unicode block (U+1100-U+11FF).</summary>
<returns>The Hangul Jamo Unicode block (U+1100-U+11FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.HangulJamoExtendedA">
<summary>Gets the Hangul Jamo Extended-A Unicode block (U+A960-U+A9F).</summary>
<returns>The Hangul Jamo Extended-A Unicode block (U+A960-U+A97F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.HangulJamoExtendedB">
<summary>Gets the Hangul Jamo Extended-B Unicode block (U+D7B0-U+D7FF).</summary>
<returns>The Hangul Jamo Extended-B Unicode block (U+D7B0-U+D7FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.HangulSyllables">
<summary>Gets the Hangul Syllables Unicode block (U+AC00-U+D7AF).</summary>
<returns>The Hangul Syllables Unicode block (U+AC00-U+D7AF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Hanunoo">
<summary>Gets the Hanunoo Unicode block (U+1720-U+173F).</summary>
<returns>The Hanunoo Unicode block (U+1720-U+173F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Hebrew">
<summary>Gets the Hebrew Unicode block (U+0590-U+05FF).</summary>
<returns>The Hebrew Unicode block (U+0590-U+05FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Hiragana">
<summary>Gets the Hiragana Unicode block (U+3040-U+309F).</summary>
<returns>The Hiragana Unicode block (U+3040-U+309F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.IdeographicDescriptionCharacters">
<summary>Gets the Ideographic Description Characters Unicode block (U+2FF0-U+2FFF).</summary>
<returns>The Ideographic Description Characters Unicode block (U+2FF0-U+2FFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.IpaExtensions">
<summary>Gets the IPA Extensions Unicode block (U+0250-U+02AF).</summary>
<returns>The IPA Extensions Unicode block (U+0250-U+02AF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Javanese">
<summary>Gets the Javanese Unicode block (U+A980-U+A9DF).</summary>
<returns>The Javanese Unicode block (U+A980-U+A9DF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Kanbun">
<summary>Gets the Kanbun Unicode block (U+3190-U+319F).</summary>
<returns>The Kanbun Unicode block (U+3190-U+319F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.KangxiRadicals">
<summary>Gets the Kangxi Radicals Supplement Unicode block (U+2F00-U+2FDF).</summary>
<returns>The Kangxi Radicals Supplement Unicode block (U+2F00-U+2FDF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Kannada">
<summary>Gets the Kannada Unicode block (U+0C81-U+0CFF).</summary>
<returns>The Kannada Unicode block (U+0C81-U+0CFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Katakana">
<summary>Gets the Katakana Unicode block (U+30A0-U+30FF).</summary>
<returns>The Katakana Unicode block (U+30A0-U+30FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.KatakanaPhoneticExtensions">
<summary>Gets the Katakana Phonetic Extensions Unicode block (U+31F0-U+31FF).</summary>
<returns>The Katakana Phonetic Extensions Unicode block (U+31F0-U+31FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.KayahLi">
<summary>Gets the Kayah Li Unicode block (U+A900-U+A92F).</summary>
<returns>The Kayah Li Unicode block (U+A900-U+A92F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Khmer">
<summary>Gets the Khmer Unicode block (U+1780-U+17FF).</summary>
<returns>The Khmer Unicode block (U+1780-U+17FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.KhmerSymbols">
<summary>Gets the Khmer Symbols Unicode block (U+19E0-U+19FF).</summary>
<returns>The Khmer Symbols Unicode block (U+19E0-U+19FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Lao">
<summary>Gets the Lao Unicode block (U+0E80-U+0EDF).</summary>
<returns>The Lao Unicode block (U+0E80-U+0EDF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Latin1Supplement">
<summary>Gets the Latin-1 Supplement Unicode block (U+00A1-U+00FF).</summary>
<returns>The Latin-1 Supplement Unicode block (U+00A1-U+00FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.LatinExtendedA">
<summary>Gets the Latin Extended-A Unicode block (U+0100-U+017F).</summary>
<returns>The Latin Extended-A Unicode block (U+0100-U+017F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.LatinExtendedAdditional">
<summary>Gets the Latin Extended Additional Unicode block (U+1E00-U+1EFF).</summary>
<returns>The Latin Extended Additional Unicode block (U+1E00-U+1EFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.LatinExtendedB">
<summary>Gets the Latin Extended-B Unicode block (U+0180-U+024F).</summary>
<returns>The Latin Extended-B Unicode block (U+0180-U+024F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.LatinExtendedC">
<summary>Gets the Latin Extended-C Unicode block (U+2C60-U+2C7F).</summary>
<returns>The Latin Extended-C Unicode block (U+2C60-U+2C7F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.LatinExtendedD">
<summary>Gets the Latin Extended-D Unicode block (U+A720-U+A7FF).</summary>
<returns>The Latin Extended-D Unicode block (U+A720-U+A7FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.LatinExtendedE">
<summary>Gets the Latin Extended-E Unicode block (U+AB30-U+AB6F).</summary>
<returns>The Latin Extended-E Unicode block (U+AB30-U+AB6F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Lepcha">
<summary>Gets the Lepcha Unicode block (U+1C00-U+1C4F).</summary>
<returns>The Lepcha Unicode block (U+1C00-U+1C4F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.LetterlikeSymbols">
<summary>Gets the Letterlike Symbols Unicode block (U+2100-U+214F).</summary>
<returns>The Letterlike Symbols Unicode block (U+2100-U+214F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Limbu">
<summary>Gets the Limbu Unicode block (U+1900-U+194F).</summary>
<returns>The Limbu Unicode block (U+1900-U+194F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Lisu">
<summary>Gets the Lisu Unicode block (U+A4D0-U+A4FF).</summary>
<returns>The Lisu Unicode block (U+A4D0-U+A4FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Malayalam">
<summary>Gets the Malayalam Unicode block (U+0D00-U+0D7F).</summary>
<returns>The Malayalam Unicode block (U+0D00-U+0D7F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Mandaic">
<summary>Gets the Mandaic Unicode block (U+0840-U+085F).</summary>
<returns>The Mandaic Unicode block (U+0840-U+085F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.MathematicalOperators">
<summary>Gets the Mathematical Operators Unicode block (U+2200-U+22FF).</summary>
<returns>The Mathematical Operators Unicode block (U+2200-U+22FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.MeeteiMayek">
<summary>Gets the Meetei Mayek Unicode block (U+ABC0-U+ABFF).</summary>
<returns>The Meetei Mayek Unicode block (U+ABC0-U+ABFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.MeeteiMayekExtensions">
<summary>Gets the Meetei Mayek Extensions Unicode block (U+AAE0-U+AAFF).</summary>
<returns>The Meetei Mayek Extensions Unicode block (U+AAE0-U+AAFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.MiscellaneousMathematicalSymbolsA">
<summary>Gets the Miscellaneous Mathematical Symbols-A Unicode block (U+27C0-U+27EF).</summary>
<returns>The Miscellaneous Mathematical Symbols-A Unicode block (U+27C0-U+27EF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.MiscellaneousMathematicalSymbolsB">
<summary>Gets the Miscellaneous Mathematical Symbols-B Unicode block (U+2980-U+29FF).</summary>
<returns>The Miscellaneous Mathematical Symbols-B Unicode block (U+2980-U+29FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.MiscellaneousSymbols">
<summary>Gets the Miscellaneous Symbols Unicode block (U+2600-U+26FF).</summary>
<returns>The Miscellaneous Symbols Unicode block (U+2600-U+26FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.MiscellaneousSymbolsandArrows">
<summary>Gets the Miscellaneous Symbols and Arrows Unicode block (U+2B00-U+2BFF).</summary>
<returns>The Miscellaneous Symbols and Arrows Unicode block (U+2B00-U+2BFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.MiscellaneousTechnical">
<summary>Gets the Miscellaneous Technical Unicode block (U+2300-U+23FF).</summary>
<returns>The Miscellaneous Technical Unicode block (U+2300-U+23FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.ModifierToneLetters">
<summary>Gets the Modifier Tone Letters Unicode block (U+A700-U+A71F).</summary>
<returns>The Modifier Tone Letters Unicode block (U+A700-U+A71F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Mongolian">
<summary>Gets the Mongolian Unicode block (U+1800-U+18AF).</summary>
<returns>The Mongolian Unicode block (U+1800-U+18AF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Myanmar">
<summary>Gets the Myanmar Unicode block (U+1000-U+109F).</summary>
<returns>The Myanmar Unicode block (U+1000-U+109F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.MyanmarExtendedA">
<summary>Gets the Myanmar Extended-A Unicode block (U+AA60-U+AA7F).</summary>
<returns>The Myanmar Extended-A Unicode block (U+AA60-U+AA7F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.MyanmarExtendedB">
<summary>Gets the Myanmar Extended-B Unicode block (U+A9E0-U+A9FF).</summary>
<returns>The Myanmar Extended-B Unicode block (U+A9E0-U+A9FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.NewTaiLue">
<summary>Gets the New Tai Lue Unicode block (U+1980-U+19DF).</summary>
<returns>The New Tai Lue Unicode block (U+1980-U+19DF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.NKo">
<summary>Gets the NKo Unicode block (U+07C0-U+07FF).</summary>
<returns>The NKo Unicode block (U+07C0-U+07FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.None">
<summary>Gets an empty Unicode range.</summary>
<returns>A Unicode range with no elements.</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.NumberForms">
<summary>Gets the Number Forms Unicode block (U+2150-U+218F).</summary>
<returns>The Number Forms Unicode block (U+2150-U+218F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Ogham">
<summary>Gets the Ogham Unicode block (U+1680-U+169F).</summary>
<returns>The Ogham Unicode block (U+1680-U+169F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.OlChiki">
<summary>Gets the Ol Chiki Unicode block (U+1C50-U+1C7F).</summary>
<returns>The Ol Chiki Unicode block (U+1C50-U+1C7F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.OpticalCharacterRecognition">
<summary>Gets the Optical Character Recognition Unicode block (U+2440-U+245F).</summary>
<returns>The Optical Character Recognition Unicode block (U+2440-U+245F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Oriya">
<summary>Gets the Oriya Unicode block (U+0B00-U+0B7F).</summary>
<returns>The Oriya Unicode block (U+0B00-U+0B7F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Phagspa">
<summary>Gets the Phags-pa Unicode block (U+A840-U+A87F).</summary>
<returns>The Phags-pa Unicode block (U+A840-U+A87F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.PhoneticExtensions">
<summary>Gets the Phonetic Extensions Unicode block (U+1D00-U+1D7F).</summary>
<returns>The Phonetic Extensions Unicode block (U+1D00-U+1D7F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.PhoneticExtensionsSupplement">
<summary>Gets the Phonetic Extensions Supplement Unicode block (U+1D80-U+1DBF).</summary>
<returns>The Phonetic Extensions Supplement Unicode block (U+1D80-U+1DBF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Rejang">
<summary>Gets the Rejang Unicode block (U+A930-U+A95F).</summary>
<returns>The Rejang Unicode block (U+A930-U+A95F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Runic">
<summary>Gets the Runic Unicode block (U+16A0-U+16FF).</summary>
<returns>The Runic Unicode block (U+16A0-U+16FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Samaritan">
<summary>Gets the Samaritan Unicode block (U+0800-U+083F).</summary>
<returns>The Samaritan Unicode block (U+0800-U+083F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Saurashtra">
<summary>Gets the Saurashtra Unicode block (U+A880-U+A8DF).</summary>
<returns>The Saurashtra Unicode block (U+A880-U+A8DF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Sinhala">
<summary>Gets the Sinhala Unicode block (U+0D80-U+0DFF).</summary>
<returns>The Sinhala Unicode block (U+0D80-U+0DFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.SmallFormVariants">
<summary>Gets the Small Form Variants Unicode block (U+FE50-U+FE6F).</summary>
<returns>The Small Form Variants Unicode block (U+FE50-U+FE6F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.SpacingModifierLetters">
<summary>Gets the Spacing Modifier Letters Unicode block (U+02B0-U+02FF).</summary>
<returns>The Spacing Modifier Letters Unicode block (U+02B0-U+02FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Specials">
<summary>Gets the Specials Unicode block (U+FFF0-U+FFFF).</summary>
<returns>The Specials Unicode block (U+FFF0-U+FFFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Sundanese">
<summary>Gets the Sundanese Unicode block (U+1B80-U+1BBF).</summary>
<returns>The Sundanese Unicode block (U+1B80-U+1BBF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.SundaneseSupplement">
<summary>Gets the Sundanese Supplement Unicode block (U+1CC0-U+1CCF).</summary>
<returns>The Sundanese Supplement Unicode block (U+1CC0-U+1CCF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.SuperscriptsandSubscripts">
<summary>Gets the Superscripts and Subscripts Unicode block (U+2070-U+209F).</summary>
<returns>The Superscripts and Subscripts Unicode block (U+2070-U+209F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.SupplementalArrowsA">
<summary>Gets the Supplemental Arrows-A Unicode block (U+27F0-U+27FF).</summary>
<returns>The Supplemental Arrows-A Unicode block (U+27F0-U+27FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.SupplementalArrowsB">
<summary>Gets the Supplemental Arrows-B Unicode block (U+2900-U+297F).</summary>
<returns>The Supplemental Arrows-B Unicode block (U+2900-U+297F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.SupplementalMathematicalOperators">
<summary>Gets the Supplemental Mathematical Operators Unicode block (U+2A00-U+2AFF).</summary>
<returns>The Supplemental Mathematical Operators Unicode block (U+2A00-U+2AFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.SupplementalPunctuation">
<summary>Gets the Supplemental Punctuation Unicode block (U+2E00-U+2E7F).</summary>
<returns>The Supplemental Punctuation Unicode block (U+2E00-U+2E7F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.SylotiNagri">
<summary>Gets the Syloti Nagri Unicode block (U+A800-U+A82F).</summary>
<returns>The Syloti Nagri Unicode block (U+A800-U+A82F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Syriac">
<summary>Gets the Syriac Unicode block (U+0700-U+074F).</summary>
<returns>The Syriac Unicode block (U+0700-U+074F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.SyriacSupplement">
<summary>A <see cref="T:System.Text.Unicode.UnicodeRange" /> corresponding to the 'Syriac Supplement' Unicode block (U+0860..U+086F).</summary>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Tagalog">
<summary>Gets the Tagalog Unicode block (U+1700-U+171F).</summary>
<returns>The Tagalog Unicode block (U+1700-U+171F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Tagbanwa">
<summary>Gets the Tagbanwa Unicode block (U+1760-U+177F).</summary>
<returns>The Tagbanwa Unicode block (U+1760-U+177F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.TaiLe">
<summary>Gets the Tai Le Unicode block (U+1950-U+197F).</summary>
<returns>The Tai Le Unicode block (U+1950-U+197F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.TaiTham">
<summary>Gets the Tai Tham Unicode block (U+1A20-U+1AAF).</summary>
<returns>The Tai Tham Unicode block (U+1A20-U+1AAF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.TaiViet">
<summary>Gets the Tai Viet Unicode block (U+AA80-U+AADF).</summary>
<returns>The Tai Viet Unicode block (U+AA80-U+AADF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Tamil">
<summary>Gets the Tamil Unicode block (U+0B80-U+0BFF).</summary>
<returns>The Tamil Unicode block (U+0B82-U+0BFA).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Telugu">
<summary>Gets the Telugu Unicode block (U+0C00-U+0C7F).</summary>
<returns>The Telugu Unicode block (U+0C00-U+0C7F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Thaana">
<summary>Gets the Thaana Unicode block (U+0780-U+07BF).</summary>
<returns>The Thaana Unicode block (U+0780-U+07BF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Thai">
<summary>Gets the Thai Unicode block (U+0E00-U+0E7F).</summary>
<returns>The Thai Unicode block (U+0E00-U+0E7F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Tibetan">
<summary>Gets the Tibetan Unicode block (U+0F00-U+0FFF).</summary>
<returns>The Tibetan Unicode block (U+0F00-U+0FFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Tifinagh">
<summary>Gets the Tifinagh Unicode block (U+2D30-U+2D7F).</summary>
<returns>The Tifinagh Unicode block (U+2D30-U+2D7F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.UnifiedCanadianAboriginalSyllabics">
<summary>Gets the Unified Canadian Aboriginal Syllabics Unicode block (U+1400-U+167F).</summary>
<returns>The Unified Canadian Aboriginal Syllabics Unicode block (U+1400-U+167F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.UnifiedCanadianAboriginalSyllabicsExtended">
<summary>Gets the Unified Canadian Aboriginal Syllabics Extended Unicode block (U+18B0-U+18FF).</summary>
<returns>The Unified Canadian Aboriginal Syllabics Extended Unicode block (U+18B0-U+18FF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.Vai">
<summary>Gets the Vai Unicode block (U+A500-U+A63F).</summary>
<returns>The Vai Unicode block (U+A500-U+A63F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.VariationSelectors">
<summary>Gets the Variation Selectors Unicode block (U+FE00-U+FE0F).</summary>
<returns>The Variation Selectors Unicode block (U+FE00-U+FE0F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.VedicExtensions">
<summary>Gets the Vedic Extensions Unicode block (U+1CD0-U+1CFF).</summary>
<returns>The Vedic Extensions Unicode block (U+1CD0-U+1CFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.VerticalForms">
<summary>Gets the Vertical Forms Unicode block (U+FE10-U+FE1F).</summary>
<returns>The Vertical Forms Unicode block (U+FE10-U+FE1F).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.YijingHexagramSymbols">
<summary>Gets the Yijing Hexagram Symbols Unicode block (U+4DC0-U+4DFF).</summary>
<returns>The Yijing Hexagram Symbols Unicode block (U+4DC0-U+4DFF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.YiRadicals">
<summary>Gets the Yi Radicals Unicode block (U+A490-U+A4CF).</summary>
<returns>The Yi Radicals Unicode block (U+A490-U+A4CF).</returns>
</member>
<member name="P:System.Text.Unicode.UnicodeRanges.YiSyllables">
<summary>Gets the Yi Syllables Unicode block (U+A000-U+A48F).</summary>
<returns>The Yi Syllables Unicode block (U+A000-U+A48F).</returns>
</member>
</members>
</doc>

Binary file not shown.

BIN
packages/System.Text.Json.9.0.3/Icon.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.1 KiB

View File

@@ -0,0 +1,23 @@
The MIT License (MIT)
Copyright (c) .NET Foundation and Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@@ -0,0 +1,257 @@
## About
<!-- A description of the package and where one can find more documentation -->
Provides high-performance and low-allocating types that serialize objects to JavaScript Object Notation (JSON) text and deserialize JSON text to objects, with UTF-8 support built-in. Also provides types to read and write JSON text encoded as UTF-8, and to create an in-memory document object model (DOM), that is read-only, for random access of the JSON elements within a structured view of the data.
## Key Features
<!-- The key features of this package -->
* High-performance reader and writer types for UTF-8 encoded JSON.
* A fully-featured JSON serializer for .NET types using reflection or source generated contracts.
* A high-performance read-only JSON DOM (JsonDocument) and a mutable DOM that interoperates with the serializer (JsonNode).
* Built-in support for async serialization, including IAsyncEnumerable support.
* Fully customizable contract model for serializable types.
## How to Use
<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
The System.Text.Json library is built-in as part of the shared framework in .NET Runtime. The package can be installed when you need to use the most recent version in older target frameworks.
Serialization:
```csharp
using System;
using System.Text.Json;
WeatherForecast forecast = new (DateTimeOffset.Now, 26.6f, "Sunny");
var serialized = JsonSerializer.Serialize(forecast);
Console.WriteLine(serialized);
// {"Date":"2023-08-02T16:01:20.9025406+00:00","TemperatureCelsius":26.6,"Summary":"Sunny"}
var forecastDeserialized = JsonSerializer.Deserialize<WeatherForecast>(serialized);
Console.WriteLine(forecast == forecastDeserialized);
// True
public record WeatherForecast(DateTimeOffset Date, float TemperatureCelsius, string? Summary);
```
Serialization using the source generator:
```csharp
using System.Text.Json;
using System.Text.Json.Serialization;
WeatherForecast forecast = new (DateTimeOffset.Now, 26.6f, "Sunny");
var serialized = JsonSerializer.Serialize(forecast, SourceGenerationContext.Default.WeatherForecast);
Console.WriteLine(serialized);
// {"Date":"2023-08-02T16:01:20.9025406+00:00","TemperatureCelsius":26.6,"Summary":"Sunny"}
var forecastDeserialized = JsonSerializer.Deserialize<WeatherForecast>(serialized, SourceGenerationContext.Default.WeatherForecast);
Console.WriteLine(forecast == forecastDeserialized);
// True
public record WeatherForecast(DateTimeOffset Date, float TemperatureCelsius, string? Summary);
[JsonSourceGenerationOptions(WriteIndented = true)]
[JsonSerializable(typeof(WeatherForecast))]
internal partial class SourceGenerationContext : JsonSerializerContext
{
}
```
Using the JSON DOM:
```csharp
using System;
using System.Text.Json;
using System.Text.Json.Nodes;
string jsonString =
@"{
""Date"": ""2019-08-01T00:00:00"",
""Temperature"": 25,
""Summary"": ""Hot"",
""DatesAvailable"": [
""2019-08-01T00:00:00"",
""2019-08-02T00:00:00""
],
""TemperatureRanges"": {
""Cold"": {
""High"": 20,
""Low"": -10
},
""Hot"": {
""High"": 60,
""Low"": 20
}
}
}
";
JsonNode forecastNode = JsonNode.Parse(jsonString)!;
// Get value from a JsonNode.
JsonNode temperatureNode = forecastNode["Temperature"]!;
Console.WriteLine($"Type={temperatureNode.GetType()}");
Console.WriteLine($"JSON={temperatureNode.ToJsonString()}");
//output:
//Type = System.Text.Json.Nodes.JsonValue`1[System.Text.Json.JsonElement]
//JSON = 25
// Get a typed value from a JsonNode.
int temperatureInt = (int)forecastNode["Temperature"]!;
Console.WriteLine($"Value={temperatureInt}");
//output:
//Value=25
// Get a typed value from a JsonNode by using GetValue<T>.
temperatureInt = forecastNode["Temperature"]!.GetValue<int>();
Console.WriteLine($"TemperatureInt={temperatureInt}");
//output:
//Value=25
// Get a JSON object from a JsonNode.
JsonNode temperatureRanges = forecastNode["TemperatureRanges"]!;
Console.WriteLine($"Type={temperatureRanges.GetType()}");
Console.WriteLine($"JSON={temperatureRanges.ToJsonString()}");
//output:
//Type = System.Text.Json.Nodes.JsonObject
//JSON = { "Cold":{ "High":20,"Low":-10},"Hot":{ "High":60,"Low":20} }
// Get a JSON array from a JsonNode.
JsonNode datesAvailable = forecastNode["DatesAvailable"]!;
Console.WriteLine($"Type={datesAvailable.GetType()}");
Console.WriteLine($"JSON={datesAvailable.ToJsonString()}");
//output:
//datesAvailable Type = System.Text.Json.Nodes.JsonArray
//datesAvailable JSON =["2019-08-01T00:00:00", "2019-08-02T00:00:00"]
// Get an array element value from a JsonArray.
JsonNode firstDateAvailable = datesAvailable[0]!;
Console.WriteLine($"Type={firstDateAvailable.GetType()}");
Console.WriteLine($"JSON={firstDateAvailable.ToJsonString()}");
//output:
//Type = System.Text.Json.Nodes.JsonValue`1[System.Text.Json.JsonElement]
//JSON = "2019-08-01T00:00:00"
// Get a typed value by chaining references.
int coldHighTemperature = (int)forecastNode["TemperatureRanges"]!["Cold"]!["High"]!;
Console.WriteLine($"TemperatureRanges.Cold.High={coldHighTemperature}");
//output:
//TemperatureRanges.Cold.High = 20
// Parse a JSON array
JsonNode datesNode = JsonNode.Parse(@"[""2019-08-01T00:00:00"",""2019-08-02T00:00:00""]")!;
JsonNode firstDate = datesNode[0]!.GetValue<DateTime>();
Console.WriteLine($"firstDate={ firstDate}");
//output:
//firstDate = "2019-08-01T00:00:00"
```
Using the low-level JSON reader/writer types
```csharp
using System;
using System.IO;
using System.Text;
using System.Text.Json;
var writerOptions = new JsonWriterOptions
{
Indented = true
};
using var stream = new MemoryStream();
using var writer = new Utf8JsonWriter(stream, writerOptions);
writer.WriteStartObject();
writer.WriteString("date", DateTimeOffset.Parse("8/2/2023 9:00 AM"));
writer.WriteNumber("temp", 42);
writer.WriteEndObject();
writer.Flush();
var jsonBytes = stream.ToArray();
string json = Encoding.UTF8.GetString(jsonBytes);
Console.WriteLine(json);
// {
// "date": "2023-08-02T09:00:00+00:00"
// "temp": 42
// }
var readerOptions = new JsonReaderOptions
{
AllowTrailingCommas = true,
CommentHandling = JsonCommentHandling.Skip
};
var reader = new Utf8JsonReader(jsonBytes, readerOptions);
while (reader.Read())
{
Console.Write(reader.TokenType);
switch (reader.TokenType)
{
case JsonTokenType.PropertyName:
case JsonTokenType.String:
{
string? text = reader.GetString();
Console.Write(" ");
Console.Write(text);
break;
}
case JsonTokenType.Number:
{
int intValue = reader.GetInt32();
Console.Write(" ");
Console.Write(intValue);
break;
}
// Other token types elided for brevity
}
Console.WriteLine();
}
// StartObject
// PropertyName date
// String 2023-08-02T09:00:00+00:00
// PropertyName temp
// Number 42
// EndObject
```
## Main Types
<!-- The main types provided in this library -->
The main types provided by this library are:
* `System.Text.Json.Utf8JsonWriter`
* `System.Text.Json.Utf8JsonReader`
* `System.Text.Json.JsonSerializer`
* `System.Text.Json.JsonConverter`
* `System.Text.Json.JsonDocument`
* `System.Text.Json.Nodes.JsonNode`
* `System.Text.Json.Serialization.Metadata.JsonTypeInfo`
## Additional Documentation
* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/system-text-json/overview)
* [API documentation](https://learn.microsoft.com/dotnet/api/system.text.json)
## Related Packages
<!-- The related packages associated with this package -->
* Lightweight data formats abstraction: [System.Memory.Data](https://www.nuget.org/packages/System.Memory.Data/)
* Serialization of HttpContent: [System.Net.Http.Json](https://www.nuget.org/packages/System.Net.Http.Json/)
## Feedback & Contributing
<!-- How to provide feedback on this package and contribute to it -->
System.Text.Json is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime).

Binary file not shown.

File diff suppressed because it is too large Load Diff

Some files were not shown because too many files have changed in this diff Show More