Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://dotnet.github.io/dotNext/api/DotNext.IO.PoolingBufferedStream.html below:

Class PoolingBufferedStream | .NEXT

Represents alternative implementation of BufferedStream that supports memory pooling.

PoolingBufferedStream

public sealed class PoolingBufferedStream : Stream, IAsyncDisposable, IBufferedWriter, IBufferWriter<byte>, IFlushable, IBufferedReader, IBufferedChannel, IResettable, IDisposable

Represents alternative implementation of BufferedStream that supports memory pooling.

public PoolingBufferedStream(Stream stream, bool leaveOpen = false)

The underlying stream to be buffered.

true to leave stream open after the object is disposed; otherwise, false.

Gets or sets buffer allocator.

public MemoryAllocator<byte>? Allocator { get; init; }

Gets the base stream.

public Stream BaseStream { get; }

When overridden in a derived class, gets a value indicating whether the current stream supports reading.

public override bool CanRead { get; }

true if the stream supports reading; otherwise, false.

When overridden in a derived class, gets a value indicating whether the current stream supports seeking.

public override bool CanSeek { get; }

true if the stream supports seeking; otherwise, false.

Gets a value that determines whether the current stream can time out.

public override bool CanTimeout { get; }

A value that determines whether the current stream can time out.

When overridden in a derived class, gets a value indicating whether the current stream supports writing.

public override bool CanWrite { get; }

true if the stream supports writing; otherwise, false.

Gets a value indicating that the stream has data in read buffer.

public bool HasBufferedDataToRead { get; }

Gets a value indicating that the stream has buffered data in write buffer.

public bool HasBufferedDataToWrite { get; }

When overridden in a derived class, gets the length in bytes of the stream.

public override long Length { get; }

A long value representing the length of the stream in bytes.

Gets the maximum size of the internal buffer, in bytes.

public int MaxBufferSize { get; init; }

When overridden in a derived class, gets or sets the position within the current stream.

public override long Position { get; set; }

The current position within the stream.

Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out.

public override int ReadTimeout { get; set; }

A value, in milliseconds, that determines how long the stream will attempt to read before timing out.

Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out.

public override int WriteTimeout { get; set; }

A value, in milliseconds, that determines how long the stream will attempt to write before timing out.

Begins an asynchronous read operation. (Consider using ReadAsync(byte[], int, int) instead.)

public override IAsyncResult BeginRead(byte[] data, int offset, int count, AsyncCallback? callback, object? state)

The byte offset in buffer at which to begin writing data read from the stream.

The maximum number of bytes to read.

An optional asynchronous callback, to be called when the read is complete.

A user-provided object that distinguishes this particular asynchronous read request from other requests.

Begins an asynchronous write operation. (Consider using WriteAsync(byte[], int, int) instead.)

public override IAsyncResult BeginWrite(byte[] data, int offset, int count, AsyncCallback? callback, object? state)

The byte offset in buffer from which to begin writing.

The maximum number of bytes to write.

An optional asynchronous callback, to be called when the write is complete.

A user-provided object that distinguishes this particular asynchronous write request from other requests.

An IAsyncResult that represents the asynchronous write, which could still be pending.

Reads the bytes from the current stream and writes them to another stream, using a specified buffer size. Both streams positions are advanced by the number of bytes copied.

public override void CopyTo(Stream destination, int bufferSize)

The stream to which the contents of the current stream will be copied.

The size of the buffer. This value must be greater than zero. The default size is 81920.

Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token. Both streams positions are advanced by the number of bytes copied.

public override Task CopyToAsync(Stream destination, int bufferSize, CancellationToken token)

The stream to which the contents of the current stream will be copied.

The size, in bytes, of the buffer. This value must be greater than zero. The default size is 81920.

A task that represents the asynchronous copy operation.

Releases the unmanaged resources used by the Stream and optionally releases the managed resources.

protected override void Dispose(bool disposing)

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Asynchronously releases the unmanaged resources used by the Stream.

public override ValueTask DisposeAsync()

A task that represents the asynchronous dispose operation.

Waits for the pending asynchronous read to complete. (Consider using ReadAsync(byte[], int, int) instead.)

public override int EndRead(IAsyncResult asyncResult)

The reference to the pending asynchronous request to finish.

The number of bytes read from the stream, between zero (0) and the number of bytes requested. ReadAsync returns zero (0) only if zero bytes were requested or if no more bytes will be available because it's at the end of the stream; otherwise, read operations do not complete until at least one byte is available. If zero bytes are requested, read operations may complete immediately or may not complete until at least one byte is available (but without consuming any data).

Ends an asynchronous write operation. (Consider using WriteAsync(byte[], int, int) instead.)

public override void EndWrite(IAsyncResult asyncResult)

A reference to the outstanding asynchronous I/O request.

protected ~PoolingBufferedStream()

When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.

public override void Flush()

Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests.

public override Task FlushAsync(CancellationToken token)

A task that represents the asynchronous flush operation.

Populates the internal buffer from the underlying stream.

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.

public override int Read(byte[] data, int offset, int count)

The zero-based byte offset in buffer at which to begin storing the data read from the current stream.

The maximum number of bytes to be read from the current stream.

The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if count is 0 or the end of the stream has been reached.

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.

public override int Read(Span<byte> data)

The total number of bytes read into the buffer. This can be less than the size of the buffer if that many bytes are not currently available, or zero (0) if the buffer's length is zero or the end of the stream has been reached.

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.

public override Task<int> ReadAsync(byte[] data, int offset, int count, CancellationToken token)

The byte offset in buffer at which to begin writing data from the stream.

The maximum number of bytes to read.

A task that represents the asynchronous read operation. The value of the TResult parameter contains the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if count is 0 or if the end of the stream has been reached.

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.

public override ValueTask<int> ReadAsync(Memory<byte> data, CancellationToken token = default)

A task that represents the asynchronous read operation. The value of its Result property contains the total number of bytes read into the buffer. The result value can be less than the length of the buffer if that many bytes are not currently available, or it can be 0 (zero) if the length of the buffer is 0 or if the end of the stream has been reached.

Fetches the internal buffer from the underlying stream.

public ValueTask<bool> ReadAsync(CancellationToken token = default)

The token that can be used to cancel the operation.

true if the data has been copied from the file to the internal buffer; false if no more data to read.

Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.

public override int ReadByte()

The unsigned byte cast to an int, or -1 if at the end of the stream.

Resets the internal buffer.

When overridden in a derived class, sets the position within the current stream.

public override long Seek(long offset, SeekOrigin origin)

A byte offset relative to the origin parameter.

A value of type SeekOrigin indicating the reference point used to obtain the new position.

The new position within the current stream.

When overridden in a derived class, sets the length of the current stream.

public override void SetLength(long value)

The desired length of the current stream in bytes.

Writes the buffered data to the underlying stream.

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.

public override void Write(byte[] data, int offset, int count)

The zero-based byte offset in buffer at which to begin copying bytes to the current stream.

The number of bytes to be written to the current stream.

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.

public override void Write(ReadOnlySpan<byte> data)

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.

public override Task WriteAsync(byte[] data, int offset, int count, CancellationToken token)

The zero-based byte offset in buffer from which to begin copying bytes to the stream.

The maximum number of bytes to write.

A task that represents the asynchronous write operation.

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.

public override ValueTask WriteAsync(ReadOnlyMemory<byte> data, CancellationToken token = default)

A task that represents the asynchronous write operation.

Writes the buffered data to the underlying stream.

public ValueTask WriteAsync(CancellationToken token = default)

The token that can be used to cancel the operation.

The task representing asynchronous execution of the operation.

Writes a byte to the current position in the stream and advances the position within the stream by one byte.

public override void WriteByte(byte value)

The byte to write to the stream.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4