FileBufferingWriteStream Class

Definition

Namespace:

Microsoft.AspNetCore.WebUtilities

Assembly:

Microsoft.AspNetCore.WebUtilities.dll

Package:

Microsoft.AspNetCore.App.Ref v8.0.0

A Stream that buffers content to be written to disk. Use DrainBufferAsync(Stream, CancellationToken) to write buffered content to a target Stream.

public ref class FileBufferingWriteStream sealed : System::IO::Stream

public sealed class FileBufferingWriteStream : System.IO.Stream

type FileBufferingWriteStream = class
    inherit Stream

Public NotInheritable Class FileBufferingWriteStream
Inherits Stream

Inheritance

Stream

FileBufferingWriteStream

Constructors

FileBufferingWriteStream(Int32, Nullable<Int64>, Func<String>)

Initializes a new instance of FileBufferingWriteStream.

Properties

CanRead	When overridden in a derived class, gets a value indicating whether the current stream supports reading.
CanSeek	When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
CanWrite	When overridden in a derived class, gets a value indicating whether the current stream supports writing.
Length	When overridden in a derived class, gets the length in bytes of the stream.
MemoryThreshold	The maximum amount of memory in bytes to allocate before switching to a file on disk.
Position	When overridden in a derived class, gets or sets the position within the current stream.

Methods

DisposeAsync()	Asynchronously releases the unmanaged resources used by the Stream.
DrainBufferAsync(PipeWriter, CancellationToken)	Drains buffered content to destination.
DrainBufferAsync(Stream, CancellationToken)	Drains buffered content to destination.
Flush()	When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.
FlushAsync(CancellationToken)	Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests.
Read(Byte[], Int32, Int32)	When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.
ReadAsync(Memory<Byte>, CancellationToken)	Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.
Seek(Int64, SeekOrigin)	When overridden in a derived class, sets the position within the current stream.
SetLength(Int64)	When overridden in a derived class, sets the length of the current stream.
Write(Byte[], Int32, Int32)	When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
WriteAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.