bjquanjiang
/
DigitalScholl
1
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1934 Commits
27 Branches
20 GiB
 
 
 
 
 
 
Tree: 245facbbc1
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '245facbbc1'
${ noResults }
DigitalScholl/Learun.Framework.Ultimate V7/packages/System.IO.Pipelines.4.7.1/lib/netstandard2.0/System.IO.Pipelines.xml

318 lines
27 KiB
Raw Blame History 

  1. <?xml version="1.0" encoding="utf-8"?>

  2. <doc>

  3.   <assembly>

  4.     <name>System.IO.Pipelines</name>

  5.   </assembly>

  6.   <members>

  7.     <member name="T:System.IO.Pipelines.FlushResult">

  8.       <summary>Result returned by <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> call.</summary>

  9.     </member>

  10.     <member name="M:System.IO.Pipelines.FlushResult.#ctor(System.Boolean,System.Boolean)">

  11.       <summary>Creates a new instance of <see cref="T:System.IO.Pipelines.FlushResult" /> setting <see cref="P:System.IO.Pipelines.FlushResult.IsCanceled" /> and <see cref="P:System.IO.Pipelines.FlushResult.IsCompleted" /> flags.</summary>

  12.       <param name="isCanceled" />

  13.       <param name="isCompleted" />

  14.     </member>

  15.     <member name="P:System.IO.Pipelines.FlushResult.IsCanceled">

  16.       <summary>

  17.         <see langword="true" /> if the current <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> operation was canceled; otherwise, <see langword="false" />.</summary>

  18.     </member>

  19.     <member name="P:System.IO.Pipelines.FlushResult.IsCompleted">

  20.       <summary>

  21.         <see langword="true" /> if the <see cref="T:System.IO.Pipelines.PipeWriter" /> is complete; otherwise, <see langword="false" />.</summary>

  22.     </member>

  23.     <member name="T:System.IO.Pipelines.IDuplexPipe">

  24.       <summary>Defines a class that provides a duplex pipe from which data can be read from and written to.</summary>

  25.     </member>

  26.     <member name="P:System.IO.Pipelines.IDuplexPipe.Input">

  27.       <summary>Gets the <see cref="T:System.IO.Pipelines.PipeReader" /> half of the duplex pipe.</summary>

  28.     </member>

  29.     <member name="P:System.IO.Pipelines.IDuplexPipe.Output">

  30.       <summary>Gets the <see cref="T:System.IO.Pipelines.PipeWriter" /> half of the duplex pipe.</summary>

  31.     </member>

  32.     <member name="T:System.IO.Pipelines.Pipe">

  33.       <summary>Default <see cref="T:System.IO.Pipelines.PipeWriter" /> and <see cref="T:System.IO.Pipelines.PipeReader" /> implementation.</summary>

  34.     </member>

  35.     <member name="M:System.IO.Pipelines.Pipe.#ctor">

  36.       <summary>Initializes the <see cref="T:System.IO.Pipelines.Pipe" /> using <see cref="P:System.IO.Pipelines.PipeOptions.Default" /> as options.</summary>

  37.     </member>

  38.     <member name="M:System.IO.Pipelines.Pipe.#ctor(System.IO.Pipelines.PipeOptions)">

  39.       <summary>Initializes the <see cref="T:System.IO.Pipelines.Pipe" /> with the specified <see cref="T:System.IO.Pipelines.PipeOptions" />.</summary>

  40.       <param name="options" />

  41.     </member>

  42.     <member name="P:System.IO.Pipelines.Pipe.Reader">

  43.       <summary>Gets the <see cref="T:System.IO.Pipelines.PipeReader" /> for this pipe.</summary>

  44.     </member>

  45.     <member name="M:System.IO.Pipelines.Pipe.Reset">

  46.       <summary>Resets the pipe.</summary>

  47.     </member>

  48.     <member name="P:System.IO.Pipelines.Pipe.Writer">

  49.       <summary>Gets the <see cref="T:System.IO.Pipelines.PipeWriter" /> for this pipe.</summary>

  50.     </member>

  51.     <member name="T:System.IO.Pipelines.PipeOptions">

  52.       <summary>Represents a set of <see cref="T:System.IO.Pipelines.Pipe" /> options.</summary>

  53.     </member>

  54.     <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)">

  55.       <summary>Creates a new instance of <see cref="T:System.IO.Pipelines.PipeOptions" />.</summary>

  56.       <param name="pool" />

  57.       <param name="readerScheduler" />

  58.       <param name="writerScheduler" />

  59.       <param name="pauseWriterThreshold" />

  60.       <param name="resumeWriterThreshold" />

  61.       <param name="minimumSegmentSize" />

  62.       <param name="useSynchronizationContext" />

  63.     </member>

  64.     <member name="P:System.IO.Pipelines.PipeOptions.Default">

  65.       <summary>Gets the default instance of <see cref="T:System.IO.Pipelines.PipeOptions" />.</summary>

  66.     </member>

  67.     <member name="P:System.IO.Pipelines.PipeOptions.MinimumSegmentSize">

  68.       <summary>Gets the minimum size of the segment requested from <see cref="P:System.IO.Pipelines.PipeOptions.Pool" />.</summary>

  69.     </member>

  70.     <member name="P:System.IO.Pipelines.PipeOptions.PauseWriterThreshold">

  71.       <summary>Gets the amount of bytes in <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> starts blocking.</summary>

  72.     </member>

  73.     <member name="P:System.IO.Pipelines.PipeOptions.Pool">

  74.       <summary>Gets the <see cref="T:System.Buffers.MemoryPool`1" /> instances used for buffer management.</summary>

  75.     </member>

  76.     <member name="P:System.IO.Pipelines.PipeOptions.ReaderScheduler">

  77.       <summary>Gets the <see cref="T:System.IO.Pipelines.PipeScheduler" /> used to execute <see cref="T:System.IO.Pipelines.PipeReader" /> callbacks.</summary>

  78.     </member>

  79.     <member name="P:System.IO.Pipelines.PipeOptions.ResumeWriterThreshold">

  80.       <summary>Gets amount of bytes in <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> stops blocking.</summary>

  81.     </member>

  82.     <member name="P:System.IO.Pipelines.PipeOptions.UseSynchronizationContext">

  83.       <summary>Gets a value that determines if asynchronous callbacks 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>

  84.     </member>

  85.     <member name="P:System.IO.Pipelines.PipeOptions.WriterScheduler">

  86.       <summary>Gets the <see cref="T:System.IO.Pipelines.PipeScheduler" /> used to execute <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks.</summary>

  87.     </member>

  88.     <member name="T:System.IO.Pipelines.PipeReader">

  89.       <summary>Defines a class that provides access to a read side of pipe.</summary>

  90.     </member>

  91.     <member name="M:System.IO.Pipelines.PipeReader.#ctor">

  92.       <summary>Initializes a new instance of the <see cref="T:System.IO.Pipelines.PipeReader" /> class.</summary>

  93.     </member>

  94.     <member name="M:System.IO.Pipelines.PipeReader.AdvanceTo(System.SequencePosition)">

  95.       <summary>Moves forward the pipeline's read cursor to after the consumed data.</summary>

  96.       <param name="consumed">Marks the extent of the data that has been successfully processed.</param>

  97.     </member>

  98.     <member name="M:System.IO.Pipelines.PipeReader.AdvanceTo(System.SequencePosition,System.SequencePosition)">

  99.       <summary>Moves forward the pipeline's read cursor to after the consumed data.</summary>

  100.       <param name="consumed">Marks the extent of the data that has been successfully processed.</param>

  101.       <param name="examined">Marks the extent of the data that has been read and examined.</param>

  102.     </member>

  103.     <member name="M:System.IO.Pipelines.PipeReader.AsStream(System.Boolean)">

  104.       <summary>Returns the underlying <see cref="T:System.IO.Stream" /> wrapped by the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>

  105.       <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>

  106.       <returns>The underlying stream.</returns>

  107.     </member>

  108.     <member name="M:System.IO.Pipelines.PipeReader.CancelPendingRead">

  109.       <summary>Cancels to currently pending or if none is pending next call to <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" />, without completing the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>

  110.     </member>

  111.     <member name="M:System.IO.Pipelines.PipeReader.Complete(System.Exception)">

  112.       <summary>Signals to the producer that the consumer is done reading.</summary>

  113.       <param name="exception">Optional <see cref="T:System.Exception" /> indicating a failure that's causing the pipeline to complete.</param>

  114.     </member>

  115.     <member name="M:System.IO.Pipelines.PipeReader.CompleteAsync(System.Exception)">

  116.       <summary>Marks the current pipe reader instance as being complete, meaning no more data will be read from it.</summary>

  117.       <param name="exception">An optional exception that indicates the failure that caused the reader to complete.</param>

  118.       <returns>A value task that represents the asynchronous complete operation.</returns>

  119.     </member>

  120.     <member name="M:System.IO.Pipelines.PipeReader.CopyToAsync(System.IO.Pipelines.PipeWriter,System.Threading.CancellationToken)">

  121.       <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 buffer size and cancellation token.</summary>

  122.       <param name="destination">The pipe writer to which the contents of the current stream will be copied.</param>

  123.       <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>

  124.       <returns>A task that represents the asynchronous copy operation.</returns>

  125.     </member>

  126.     <member name="M:System.IO.Pipelines.PipeReader.CopyToAsync(System.IO.Stream,System.Threading.CancellationToken)">

  127.       <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>

  128.       <param name="destination">The stream to which the contents of the current stream will be copied.</param>

  129.       <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>

  130.       <returns>A task that represents the asynchronous copy operation.</returns>

  131.     </member>

  132.     <member name="M:System.IO.Pipelines.PipeReader.Create(System.IO.Stream,System.IO.Pipelines.StreamPipeReaderOptions)">

  133.       <summary>Creates a <see cref="T:System.IO.Pipelines.PipeReader" /> wrapping the specified <see cref="T:System.IO.Stream" />.</summary>

  134.       <param name="stream">The stream that the pipe reader will wrap.</param>

  135.       <param name="readerOptions">The options to configure the pipe reader.</param>

  136.       <returns>A <see cref="T:System.IO.Pipelines.PipeReader" /> that wraps the <see cref="T:System.IO.Stream" />.</returns>

  137.     </member>

  138.     <member name="M:System.IO.Pipelines.PipeReader.OnWriterCompleted(System.Action{System.Exception,System.Object},System.Object)">

  139.       <summary>Registers a callback that executes when the <see cref="T:System.IO.Pipelines.PipeWriter" /> side of the pipe is completed.</summary>

  140.       <param name="callback">The callback to register.</param>

  141.       <param name="state">The state object to pass to <paramref name="callback" /> when it's invoked.</param>

  142.     </member>

  143.     <member name="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)">

  144.       <summary>Asynchronously reads a sequence of bytes from the current <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>

  145.       <param name="cancellationToken" />

  146.       <returns>A <see cref="T:System.Threading.Tasks.ValueTask`1" /> representing the asynchronous read operation.</returns>

  147.     </member>

  148.     <member name="M:System.IO.Pipelines.PipeReader.TryRead(System.IO.Pipelines.ReadResult@)">

  149.       <summary>Attempts to synchronously read data the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>

  150.       <param name="result">The <see cref="T:System.IO.Pipelines.ReadResult" /></param>

  151.       <returns>

  152.         <see langword="true" /> if data was available, or if the call was canceled or the writer was completed; otherwise, <see langword="false" />.</returns>

  153.     </member>

  154.     <member name="T:System.IO.Pipelines.PipeScheduler">

  155.       <summary>Abstraction for running <see cref="T:System.IO.Pipelines.PipeReader" /> and <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks and continuations.</summary>

  156.     </member>

  157.     <member name="M:System.IO.Pipelines.PipeScheduler.#ctor" />

  158.     <member name="P:System.IO.Pipelines.PipeScheduler.Inline">

  159.       <summary>The <see cref="T:System.IO.Pipelines.PipeScheduler" /> implementation that runs callbacks inline.</summary>

  160.     </member>

  161.     <member name="M:System.IO.Pipelines.PipeScheduler.Schedule(System.Action{System.Object},System.Object)">

  162.       <summary>Requests <paramref name="action" /> to be run on scheduler with <paramref name="state" /> being passed in.</summary>

  163.       <param name="action" />

  164.       <param name="state" />

  165.     </member>

  166.     <member name="P:System.IO.Pipelines.PipeScheduler.ThreadPool">

  167.       <summary>The <see cref="T:System.IO.Pipelines.PipeScheduler" /> implementation that queues callbacks to thread pool.</summary>

  168.     </member>

  169.     <member name="T:System.IO.Pipelines.PipeWriter">

  170.       <summary>Defines a class that provides a pipeline to which data can be written.</summary>

  171.     </member>

  172.     <member name="M:System.IO.Pipelines.PipeWriter.#ctor">

  173.       <summary>Initializes a new instance of the class.</summary>

  174.     </member>

  175.     <member name="M:System.IO.Pipelines.PipeWriter.Advance(System.Int32)">

  176.       <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 request a new buffer after calling <see cref="M:System.IO.Pipelines.PipeWriter.Advance(System.Int32)" /> to continue writing more data; you cannot write to a previously acquired buffer.</summary>

  177.       <param name="bytes">The number of bytes written to the <see cref="T:System.Span`1" /> or <see cref="T:System.Memory`1" />.</param>

  178.     </member>

  179.     <member name="M:System.IO.Pipelines.PipeWriter.AsStream(System.Boolean)">

  180.       <summary>Returns the underlying <see cref="T:System.IO.Stream" /> wrapped by the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>

  181.       <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>

  182.       <returns>The underlying stream.</returns>

  183.     </member>

  184.     <member name="M:System.IO.Pipelines.PipeWriter.CancelPendingFlush">

  185.       <summary>Cancels the pending <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> operation. If there is none, cancels next <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> operation, without completing the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>

  186.     </member>

  187.     <member name="M:System.IO.Pipelines.PipeWriter.Complete(System.Exception)">

  188.       <summary>Marks the <see cref="T:System.IO.Pipelines.PipeWriter" /> as being complete, meaning no more items will be written to it.</summary>

  189.       <param name="exception">Optional <see cref="T:System.Exception" /> indicating a failure that's causing the pipeline to complete.</param>

  190.     </member>

  191.     <member name="M:System.IO.Pipelines.PipeWriter.CompleteAsync(System.Exception)">

  192.       <summary>Marks the current pipe writer instance as being complete, meaning no more data will be written to it.</summary>

  193.       <param name="exception">An optional exception that indicates the failure that caused the pipeline to complete.</param>

  194.       <returns>A value task that represents the asynchronous complete operation.</returns>

  195.     </member>

  196.     <member name="M:System.IO.Pipelines.PipeWriter.CopyFromAsync(System.IO.Stream,System.Threading.CancellationToken)">

  197.       <summary>Asynchronously reads the bytes from the specified stream and writes them to the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>

  198.       <param name="source">The stream from which the contents will be copied.</param>

  199.       <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>

  200.       <returns>A task that represents the asynchronous copy operation.</returns>

  201.     </member>

  202.     <member name="M:System.IO.Pipelines.PipeWriter.Create(System.IO.Stream,System.IO.Pipelines.StreamPipeWriterOptions)">

  203.       <summary>Creates a <see cref="T:System.IO.Pipelines.PipeWriter" /> wrapping the specified <see cref="T:System.IO.Stream" />.</summary>

  204.       <param name="stream">The stream that the pipe writer will wrap.</param>

  205.       <param name="writerOptions">The options to configure the pipe writer.</param>

  206.       <returns>A <see cref="T:System.IO.Pipelines.PipeWriter" /> that wraps the <see cref="T:System.IO.Stream" />.</returns>

  207.     </member>

  208.     <member name="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)">

  209.       <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>

  210.       <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>

  211.       <returns>A task that represents and wraps the asynchronous flush operation.</returns>

  212.     </member>

  213.     <member name="M:System.IO.Pipelines.PipeWriter.GetMemory(System.Int32)">

  214.       <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>

  215.       <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>

  216.       <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>

  217.       <exception cref="T:System.OutOfMemoryException">The requested buffer size is not available.</exception>

  218.     </member>

  219.     <member name="M:System.IO.Pipelines.PipeWriter.GetSpan(System.Int32)">

  220.       <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>

  221.       <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>

  222.       <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>

  223.       <exception cref="T:System.OutOfMemoryException">The requested buffer size is not available.</exception>

  224.     </member>

  225.     <member name="M:System.IO.Pipelines.PipeWriter.OnReaderCompleted(System.Action{System.Exception,System.Object},System.Object)">

  226.       <summary>Registers a callback that executes when the <see cref="T:System.IO.Pipelines.PipeReader" /> side of the pipe is completed.</summary>

  227.       <param name="callback">The callback to register.</param>

  228.       <param name="state">The state object to pass to <paramref name="callback" /> when it's invoked.</param>

  229.     </member>

  230.     <member name="M:System.IO.Pipelines.PipeWriter.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)">

  231.       <summary>Writes the specified byte memory range to the pipe and makes data accessible to the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>

  232.       <param name="source">The read-only byte memory region to write.</param>

  233.       <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>

  234.       <returns>A task that represents the asynchronous write operation, and wraps the flush asynchronous operation.</returns>

  235.     </member>

  236.     <member name="T:System.IO.Pipelines.ReadResult">

  237.       <summary>The result of a <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> call.</summary>

  238.     </member>

  239.     <member name="M:System.IO.Pipelines.ReadResult.#ctor(System.Buffers.ReadOnlySequence{System.Byte},System.Boolean,System.Boolean)">

  240.       <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>

  241.       <param name="buffer" />

  242.       <param name="isCanceled" />

  243.       <param name="isCompleted" />

  244.     </member>

  245.     <member name="P:System.IO.Pipelines.ReadResult.Buffer">

  246.       <summary>Gets the <see cref="T:System.Buffers.ReadOnlySequence`1" /> that was read.</summary>

  247.     </member>

  248.     <member name="P:System.IO.Pipelines.ReadResult.IsCanceled">

  249.       <summary>

  250.         <see langword="true" /> if the current <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> operation was canceled; otherwise, <see langword="false" />.</summary>

  251.     </member>

  252.     <member name="P:System.IO.Pipelines.ReadResult.IsCompleted">

  253.       <summary>

  254.         <see langword="true" /> if the <see cref="T:System.IO.Pipelines.PipeReader" /> is complete; otherwise, <see langword="false" />.</summary>

  255.     </member>

  256.     <member name="T:System.IO.Pipelines.StreamPipeExtensions">

  257.       <summary>Provides extension methods for <see cref="T:System.IO.Stream" /> that support read and write operations directly into pipes.</summary>

  258.     </member>

  259.     <member name="M:System.IO.Pipelines.StreamPipeExtensions.CopyToAsync(System.IO.Stream,System.IO.Pipelines.PipeWriter,System.Threading.CancellationToken)">

  260.       <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>

  261.       <param name="source">The stream from which the contents of the current stream will be copied.</param>

  262.       <param name="destination">The writer to which the contents of the source stream will be copied.</param>

  263.       <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>

  264.       <returns>A task that represents the asynchronous copy operation.</returns>

  265.     </member>

  266.     <member name="T:System.IO.Pipelines.StreamPipeReaderOptions">

  267.       <summary>Represents a set of options for controlling the creation of the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>

  268.     </member>

  269.     <member name="M:System.IO.Pipelines.StreamPipeReaderOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.Int32,System.Int32,System.Boolean)">

  270.       <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>

  271.       <param name="pool">The memory pool to use when allocating memory. The default value is <see langword="null" />.</param>

  272.       <param name="bufferSize">The minimum buffer size to use when renting memory from the <paramref name="pool" />. The default value is 4096.</param>

  273.       <param name="minimumReadSize">The threshold of remaining bytes in the buffer before a new buffer is allocated. The default value is 1024.</param>

  274.       <param name="leaveOpen">

  275.         <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>

  276.     </member>

  277.     <member name="P:System.IO.Pipelines.StreamPipeReaderOptions.BufferSize">

  278.       <summary>Gets the minimum buffer size to use when renting memory from the <see cref="P:System.IO.Pipelines.StreamPipeReaderOptions.Pool" />.</summary>

  279.       <returns>The buffer size.</returns>

  280.     </member>

  281.     <member name="P:System.IO.Pipelines.StreamPipeReaderOptions.LeaveOpen">

  282.       <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>

  283.       <returns>

  284.         <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>

  285.     </member>

  286.     <member name="P:System.IO.Pipelines.StreamPipeReaderOptions.MinimumReadSize">

  287.       <summary>Gets the threshold of remaining bytes in the buffer before a new buffer is allocated.</summary>

  288.       <returns>The minimum read size.</returns>

  289.     </member>

  290.     <member name="P:System.IO.Pipelines.StreamPipeReaderOptions.Pool">

  291.       <summary>Gets the <see cref="T:System.Buffers.MemoryPool`1" /> to use when allocating memory.</summary>

  292.       <returns>A memory pool instance.</returns>

  293.     </member>

  294.     <member name="T:System.IO.Pipelines.StreamPipeWriterOptions">

  295.       <summary>Represents a set of options for controlling the creation of the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>

  296.     </member>

  297.     <member name="M:System.IO.Pipelines.StreamPipeWriterOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.Int32,System.Boolean)">

  298.       <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>

  299.       <param name="pool">The memory pool to use when allocating memory. The default value is <see langword="null" />.</param>

  300.       <param name="minimumBufferSize">The minimum buffer size to use when renting memory from the <paramref name="pool" />. The default value is 4096.</param>

  301.       <param name="leaveOpen">

  302.         <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>

  303.     </member>

  304.     <member name="P:System.IO.Pipelines.StreamPipeWriterOptions.LeaveOpen">

  305.       <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>

  306.       <returns>

  307.         <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>

  308.     </member>

  309.     <member name="P:System.IO.Pipelines.StreamPipeWriterOptions.MinimumBufferSize">

  310.       <summary>Gets the minimum buffer size to use when renting memory from the <see cref="P:System.IO.Pipelines.StreamPipeWriterOptions.Pool" />.</summary>

  311.       <returns>An integer representing the minimum buffer size.</returns>

  312.     </member>

  313.     <member name="P:System.IO.Pipelines.StreamPipeWriterOptions.Pool">

  314.       <summary>Gets the <see cref="T:System.Buffers.MemoryPool`1" /> to use when allocating memory.</summary>

  315.       <returns>A memory pool instance.</returns>

  316.     </member>

  317.   </members>

  318. </doc>