Class MD5Stream

Namespace

Amazon.Runtime.Internal.Util

Assembly

AWSSDK.Core.dll

A wrapper stream that calculates an MD5 hash of the base stream as it is being read or written. The calculated hash is only available after the stream is closed or CalculateHash is called. After calling CalculateHash, any further reads on the streams will not change the CalculatedHash. If an ExpectedHash is specified and is not equal to the calculated hash, Close or CalculateHash methods will throw an AmazonClientException. If base stream's position is not 0 or HashOnReads is true and the entire stream is not read, the CalculatedHash will be set to an empty byte array and comparison to ExpectedHash will not be made.

public class MD5Stream : HashStream<HashingWrapperMD5>, IDisposable, IAsyncDisposable

Inheritance

object

MarshalByRefObject

Stream

WrapperStream

HashStream

HashStream<HashingWrapperMD5>

MD5Stream

Implements

IDisposable

IAsyncDisposable

Inherited Members

HashStream.Read(byte[], int, int)

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

HashStream.Dispose(bool)

HashStream.Seek(long, SeekOrigin)

HashStream.CalculateHash()

HashStream.Reset()

HashStream.CompareHashes(byte[], byte[])

HashStream.Algorithm

HashStream.FinishedHashing

HashStream.CurrentPosition

HashStream.CalculatedHash

HashStream.ExpectedHash

HashStream.ExpectedLength

HashStream.CanSeek

HashStream.Position

HashStream.Length

WrapperStream.GetNonWrapperBaseStream()

WrapperStream.GetSeekableBaseStream()

WrapperStream.GetNonWrapperBaseStream(Stream)

WrapperStream.SearchWrappedStream(Func<Stream, bool>)

WrapperStream.SearchWrappedStream(Stream, Func<Stream, 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.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

MD5Stream(Stream, byte[], long)

Initializes an MD5Stream with a base stream.

public MD5Stream(Stream baseStream, byte[] expectedHash, long expectedLength)

Parameters

baseStream Stream

Stream to calculate hash for.

expectedHash byte[]

Expected hash. Will be compared against calculated hash on stream close. Pass in null to disable check.

expectedLength long

Expected length of the stream. If the reading stops before reaching this position, CalculatedHash will be set to empty array.

Exceptions

AmazonClientException

Exception thrown during Close() or CalculateHash(), if ExpectedHash is set and is different from CalculateHash that the stream calculates, provided that CalculatedHash is not a zero-length byte array.