System.IO.Pipelines

Result returned by call.

Initializes a new instance of struct setting the and flags.

to indicate the current operation that produced this was canceled by ; otherwise, . to indicate the reader is no longer reading data written to the .

Gets a value that indicates whether the current operation was canceled by .

if the current operation was canceled by ; otherwise, .

Gets a value that indicates the reader is no longer reading data written to the .

if the reader is no longer reading data written to the ; otherwise, .

Defines a class that provides a duplex pipe from which data can be read from and written to.

Gets the half of the duplex pipe.

Gets the half of the duplex pipe.

The default and implementation.

Initializes a new instance of the class using as options.

Initializes a new instance of the class with the specified options.

The set of options for this pipe.

Resets the pipe.

Gets the for this pipe.

A instance for this pipe.

Gets the for this pipe.

A instance for this pipe.

Represents a set of options.

Initializes a new instance of the class with the specified parameters.

The pool of memory blocks to be used for buffer management. The to be used to execute callbacks and async continuations. The used to execute callbacks and async continuations. The number of bytes in the before starts blocking. A value of zero prevents from ever blocking, effectively making the number of bytes in the unlimited. The number of bytes in the when stops blocking. The minimum size of the segment requested from . if asynchronous continuations should be executed on the they were captured on; otherwise. This takes precedence over the schedulers specified in and .

Gets the default instance of .

A object initialized with default parameters.

Gets the minimum size of the segment requested from the .

The minimum size of the segment requested from the .

Gets the number of bytes in the when starts blocking. A value of zero prevents from ever blocking, effectively making the number of bytes in the unlimited.

The number of bytes in the when starts blocking.

Gets the object used for buffer management.

A pool of memory blocks used for buffer management.

Gets the used to execute callbacks and async continuations.

A that is used to execute callbacks and async continuations.

Gets the number of bytes in the when stops blocking.

The number of bytes in the when stops blocking.

Gets a value that determines if asynchronous callbacks and continuations should be executed on the they were captured on. This takes precedence over the schedulers specified in and .

if asynchronous callbacks and continuations should be executed on the they were captured on; otherwise, .

Gets the used to execute callbacks and async continuations.

A object used to execute callbacks and async continuations.

Defines a class that provides access to a read side of pipe.

Initializes a new instance of the class.

Moves forward the pipeline's read cursor to after the consumed data, marking the data as processed.

Marks the extent of the data that has been successfully processed.

Moves forward the pipeline's read cursor to after the consumed data, marking the data as processed, read and examined.

Marks the extent of the data that has been successfully processed. Marks the extent of the data that has been read and examined.

Returns a representation of the .

An optional flag that indicates whether disposing the returned leaves open () or completes (). A stream that represents the .

Cancels the pending operation without causing it to throw and without completing the . If there is no pending operation, this cancels the next operation.

Signals to the producer that the consumer is done reading.

Optional indicating a failure that's causing the pipeline to complete.

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

An optional exception that indicates the failure that caused the reader to complete. A value task that represents the asynchronous complete operation.

Asynchronously reads the bytes from the and writes them to the specified , using a specified buffer size and cancellation token.

The pipe writer to which the contents of the current stream will be copied. The token to monitor for cancellation requests. The default value is . A task that represents the asynchronous copy operation.

Asynchronously reads the bytes from the and writes them to the specified stream, using a specified cancellation token.

The stream to which the contents of the current stream will be copied. The token to monitor for cancellation requests. The default value is . A task that represents the asynchronous copy operation.

Creates a wrapping the specified .

The sequence to wrap. A that wraps the .

Creates a wrapping the specified .

The stream that the pipe reader will wrap. The options to configure the pipe reader. A that wraps the .

Registers a callback that executes when the side of the pipe is completed.

The callback to register. The state object to pass to when it's invoked.

Asynchronously reads a sequence of bytes from the current .

The token to monitor for cancellation requests. The default value is . A representing the asynchronous read operation.

Asynchronously reads a sequence of bytes from the current .

The minimum length that needs to be buffered in order for the call to return. The token to monitor for cancellation requests. The default value is . A representing the asynchronous read operation.

Asynchronously reads a sequence of bytes from the current .

The minimum length that needs to be buffered in order for the call to return. The token to monitor for cancellation requests. The default value is . A representing the asynchronous read operation.

Attempts to synchronously read data the .

When this method returns , this value is set to a instance that represents the result of the read call; otherwise, this value is set to . if data was available, or if the call was canceled or the writer was completed; otherwise, .

Abstraction for running and callbacks and continuations.

Initializes new a instance.

Requests to be run on scheduler with being passed in.

The single-parameter action delegate to schedule. The parameter to pass to the delegate.

The implementation that runs callbacks inline.

A instance that runs callbacks inline.

The implementation that queues callbacks to the thread pool.

A instance that queues callbacks to the thread pool.

Defines a class that provides a pipeline to which data can be written.

Initializes a new instance of the class.

Notifies the that bytes were written to the output or . You must request a new buffer after calling to continue writing more data; you cannot write to a previously acquired buffer.

The number of bytes written to the or .

Returns a representation of the .

An optional flag that indicates whether disposing the returned leaves open () or completes (). A stream that represents the .

Cancels the pending or operation without causing the operation to throw and without completing the . If there is no pending operation, this cancels the next operation.

Marks the as being complete, meaning no more items will be written to it.

Optional indicating a failure that's causing the pipeline to complete.

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

An optional exception that indicates the failure that caused the pipeline to complete. A value task that represents the asynchronous complete operation.

Asynchronously reads the bytes from the specified stream and writes them to the .

The stream from which the contents will be copied. The token to monitor for cancellation requests. The default value is . A task that represents the asynchronous copy operation.

Creates a wrapping the specified .

The stream that the pipe writer will wrap. The options to configure the pipe writer. A that wraps the .

Makes bytes written available to and runs continuation.

The token to monitor for cancellation requests. The default value is . A task that represents and wraps the asynchronous flush operation.

Returns a to write to that is at least the requested size, as specified by the parameter.

The minimum length of the returned . If 0, a non-empty memory buffer of arbitrary size is returned. The requested buffer size is not available. A memory buffer of at least bytes. If is 0, returns a non-empty buffer of arbitrary size.

Returns a to write to that is at least the requested size, as specified by the parameter.

The minimum length of the returned . If 0, a non-empty buffer of arbitrary size is returned. The requested buffer size is not available. A buffer of at least bytes. If is 0, returns a non-empty buffer of arbitrary size.

Registers a callback that executes when the side of the pipe is completed.

The callback to register. The state object to pass to when it's invoked.

Writes the specified byte memory range to the pipe and makes data accessible to the .

The read-only byte memory region to write. The token to monitor for cancellation requests. The default value is . A task that represents the asynchronous write operation, and wraps the flush asynchronous operation.

Gets a value that indicates whether the current supports reporting the count of unflushed bytes.

If a class derived from does not support getting the unflushed bytes, calls to throw .

When overridden in a derived class, gets the count of unflushed bytes within the current writer.

The does not support getting the unflushed byte count.

Represents the result of a call.

Creates a new instance of setting and flags.

The read-only sequence containing the bytes of data that were read in the call. A flag that indicates if the operation that produced this was canceled by . A flag that indicates whether the end of the data stream has been reached.

Gets the that was read.

A read-only sequence containing the bytes of data that were read in the call.

Gets a value that indicates whether the current operation was canceled by .

if the operation that produced this was canceled by ; otherwise, .

Gets a value that indicates whether the end of the data stream has been reached.

if the end of the data stream has been reached; otherwise, .

Provides extension methods for that support read and write operations directly into pipes.

Asynchronously reads the bytes from the and writes them to the specified , using a cancellation token.

The stream from which the contents of the current stream will be copied. The writer to which the contents of the source stream will be copied. The token to monitor for cancellation requests. The default value is . A task that represents the asynchronous copy operation.

Represents a set of options for controlling the creation of the .

Initializes a 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 completes.

The memory pool to use when allocating memory. The default value is . The minimum buffer size to use when renting memory from the . The default value is 4096. The threshold of remaining bytes in the buffer before a new buffer is allocated. The default value is 1024. to leave the underlying stream open after the completes; to close it. The default is .

Initializes a 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 completes.

The memory pool to use when allocating memory. The default value is . The minimum buffer size to use when renting memory from the . The default value is 4096. The threshold of remaining bytes in the buffer before a new buffer is allocated. The default value is 1024. to leave the underlying stream open after the completes; to close it. The default is . if reads with an empty buffer should be issued to the underlying stream before allocating memory; otherwise, .

Gets the minimum buffer size to use when renting memory from the .

The buffer size.

Gets the value that indicates if the underlying stream should be left open after the completes.

if the underlying stream should be left open after the completes; otherwise, .

Gets the threshold of remaining bytes in the buffer before a new buffer is allocated.

The minimum read size.

Gets the to use when allocating memory.

A memory pool instance.

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.

if reads with an empty buffer should be issued to the underlying stream before allocating memory; otherwise, .

Represents a set of options for controlling the creation of the .

Initializes a instance, optionally specifying a memory pool, a minimum buffer size, and whether the underlying stream should be left open after the completes.

The memory pool to use when allocating memory. The default value is . The minimum buffer size to use when renting memory from the . The default value is 4096. to leave the underlying stream open after the completes; to close it. The default is .

Gets the value that indicates if the underlying stream should be left open after the completes.

if the underlying stream should be left open after the completes; otherwise, .

Gets the minimum buffer size to use when renting memory from the .

An integer representing the minimum buffer size.

Gets the to use when allocating memory.

A memory pool instance.