Class CachingWrapperStream

Namespace

Amazon.Runtime.Internal.Util

Assembly

AWSSDK.Core.dll

A stream which caches the contents of the underlying stream as it reads it.

public class CachingWrapperStream : WrapperStream, IDisposable, IAsyncDisposable

Inheritance

object

MarshalByRefObject

Stream

WrapperStream

CachingWrapperStream

Implements

IDisposable

IAsyncDisposable

Inherited Members

WrapperStream.GetNonWrapperBaseStream()

WrapperStream.GetSeekableBaseStream()

WrapperStream.GetNonWrapperBaseStream(Stream)

WrapperStream.SearchWrappedStream(Func<Stream, bool>)

WrapperStream.SearchWrappedStream(Stream, Func<Stream, bool>)

WrapperStream.Dispose(bool)

WrapperStream.Flush()

WrapperStream.SetLength(long)

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

WrapperStream.FlushAsync(CancellationToken)

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

WrapperStream.BaseStream

WrapperStream.CanRead

WrapperStream.CanWrite

WrapperStream.Length

WrapperStream.ReadTimeout

WrapperStream.WriteTimeout

Stream.Null

Stream.CopyTo(Stream)

Stream.CopyTo(Stream, int)

Stream.CopyToAsync(Stream)

Stream.CopyToAsync(Stream, int)

Stream.CopyToAsync(Stream, CancellationToken)

Stream.CopyToAsync(Stream, int, CancellationToken)

Stream.Dispose()

Stream.Close()

Stream.DisposeAsync()

Stream.FlushAsync()

Stream.CreateWaitHandle()

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

Stream.EndRead(IAsyncResult)

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

Stream.ReadAsync(Memory<byte>, CancellationToken)

Stream.ReadExactlyAsync(Memory<byte>, CancellationToken)

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

Stream.ReadAtLeastAsync(Memory<byte>, int, bool, CancellationToken)

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

Stream.EndWrite(IAsyncResult)

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

Stream.WriteAsync(ReadOnlyMemory<byte>, CancellationToken)

Stream.Read(Span<byte>)

Stream.ReadByte()

Stream.ReadExactly(Span<byte>)

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

Stream.ReadAtLeast(Span<byte>, int, bool)

Stream.Write(ReadOnlySpan<byte>)

Stream.WriteByte(byte)

Stream.Synchronized(Stream)

Stream.ObjectInvariant()

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

Stream.ValidateCopyToArguments(Stream, int)

Stream.CanTimeout

MarshalByRefObject.GetLifetimeService()

MarshalByRefObject.InitializeLifetimeService()

MarshalByRefObject.MemberwiseClone(bool)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

CachingWrapperStream(Stream, int?)

Initializes the CachingWrapperStream with a base stream.

public CachingWrapperStream(Stream baseStream, int? cacheLimit = null)

Parameters

baseStream Stream

The stream to be wrapped.

cacheLimit int?

Maximum number of bytes to be cached.

Properties

AllReadBytes

All the bytes read by the stream.

public List<byte> AllReadBytes { get; }

Property Value

List<byte>

CanSeek

Gets a value indicating whether the current stream supports seeking. CachingWrapperStream does not support seeking, this will always be false.

public override bool CanSeek { get; }

Property Value

bool

LoggableReadBytes

All the bytes read by the stream constrained with _cacheLimit

public List<byte> LoggableReadBytes { get; }

Property Value

List<byte>

Position

Gets or sets the position within the current stream. CachingWrapperStream does not support seeking, attempting to set Position will throw NotSupportedException.

public override long Position { get; set; }

Property Value

long

Methods

Read(byte[], int, int)

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.

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

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

Parameters

buffer byte[]

offset int

count int

cancellationToken CancellationToken

Returns

Task<int>

Seek(long, SeekOrigin)

Sets the position within the current stream. CachingWrapperStream does not support seeking, attempting to call Seek will throw NotSupportedException.

public override long Seek(long offset, SeekOrigin origin)

Parameters

offset long

A byte offset relative to the origin parameter.

origin SeekOrigin

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

Returns

long

The new position within the current stream.