Class PushbackStream

Namespace

Org.BouncyCastle.Utilities.IO

Assembly

BouncyCastle.Cryptography.dll

public class PushbackStream : FilterStream, IAsyncDisposable, IDisposable

Inheritance

object

MarshalByRefObject

Stream

FilterStream

PushbackStream

Implements

IAsyncDisposable

IDisposable

Inherited Members

FilterStream.s

FilterStream.CanRead

FilterStream.CanSeek

FilterStream.CanWrite

FilterStream.Flush()

FilterStream.Length

FilterStream.Position

FilterStream.Seek(long, SeekOrigin)

FilterStream.SetLength(long)

FilterStream.Write(byte[], int, int)

FilterStream.Write(ReadOnlySpan<byte>)

FilterStream.WriteAsync(ReadOnlyMemory<byte>, CancellationToken)

FilterStream.WriteByte(byte)

FilterStream.Detach(bool)

FilterStream.Dispose(bool)

Stream.Null

Stream.BeginRead(byte[], int, int, AsyncCallback, object)

Stream.BeginWrite(byte[], int, int, AsyncCallback, object)

Stream.Close()

Stream.CopyTo(Stream)

Stream.CopyToAsync(Stream)

Stream.CopyToAsync(Stream, int)

Stream.CopyToAsync(Stream, CancellationToken)

Stream.CreateWaitHandle()

Stream.Dispose()

Stream.DisposeAsync()

Stream.EndRead(IAsyncResult)

Stream.EndWrite(IAsyncResult)

Stream.FlushAsync()

Stream.FlushAsync(CancellationToken)

Stream.ObjectInvariant()

Stream.ReadAsync(byte[], int, int)

Stream.ReadAsync(byte[], int, int, CancellationToken)

Stream.Synchronized(Stream)

Stream.ValidateBufferArguments(byte[], int, int)

Stream.ValidateCopyToArguments(Stream, int)

Stream.WriteAsync(byte[], int, int)

Stream.WriteAsync(byte[], int, int, CancellationToken)

Stream.CanTimeout

Stream.ReadTimeout

Stream.WriteTimeout

MarshalByRefObject.GetLifetimeService()

MarshalByRefObject.InitializeLifetimeService()

MarshalByRefObject.MemberwiseClone(bool)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PushbackStream(Stream)

public PushbackStream(Stream s)

Parameters

s Stream

Methods

CopyTo(Stream, int)

Reads the bytes from the current stream and writes them to another stream, using a specified buffer size.

public override void CopyTo(Stream destination, int bufferSize)

Parameters

destination Stream

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

bufferSize int

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

Exceptions

ArgumentNullException

destination is null.

ArgumentOutOfRangeException

bufferSize is negative or zero.

NotSupportedException

The current stream does not support reading.

-or-

destination does not support writing.

ObjectDisposedException

Either the current stream or destination were closed before the CopyTo(Stream) method was called.

IOException

An I/O error occurred.

CopyToAsync(Stream, int, CancellationToken)

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

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

Parameters

destination Stream

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

bufferSize int

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

cancellationToken CancellationToken

The token to monitor for cancellation requests. The default value is None.

Returns

Task

A task that represents the asynchronous copy operation.

Exceptions

ArgumentNullException

destination is null.

ArgumentOutOfRangeException

buffersize is negative or zero.

ObjectDisposedException

Either the current stream or the destination stream is disposed.

NotSupportedException

The current stream does not support reading, or the destination stream does not support writing.

Read(byte[], int, int)

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[] buffer, int offset, int count)

Parameters

buffer byte[]

An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.

offset int

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

count int

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

Returns

int

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 the end of the stream has been reached.

Exceptions

ArgumentException

The sum of offset and count is larger than the buffer length.

ArgumentNullException

buffer is null.

ArgumentOutOfRangeException

offset or count is negative.

IOException

An I/O error occurs.

NotSupportedException

The stream does not support reading.

ObjectDisposedException

Methods were called after the stream was closed.

Read(Span<byte>)

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> buffer)

Parameters

buffer Span<byte>

A region of memory. When this method returns, the contents of this region are replaced by the bytes read from the current source.

Returns

int

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

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.

public override ValueTask<int> ReadAsync(Memory<byte> buffer, CancellationToken cancellationToken = default)

Parameters

buffer Memory<byte>

The region of memory to write the data into.

cancellationToken CancellationToken

The token to monitor for cancellation requests. The default value is None.

Returns

ValueTask<int>

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 number of bytes allocated in the buffer if that many bytes are not currently available, or it can be 0 (zero) if the end of the stream has been reached.

ReadByte()

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()

Returns

int

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

Exceptions

NotSupportedException

The stream does not support reading.

ObjectDisposedException

Methods were called after the stream was closed.

Unread(int)

public virtual void Unread(int b)

Parameters

b int