[WIP] Alternate approach to async reads in ZipAESStream

src/ICSharpCode.SharpZipLib/Core/StreamUtils.cs

@@ -66,16 +66,8 @@ public static void ReadFully(Stream stream, byte[] buffer, int offset, int count
 			}
 		}
 
-		/// <summary>
-		/// Read as much data as possible from a <see cref="Stream"/>", up to the requested number of bytes
-		/// </summary>
-		/// <param name="stream">The stream to read data from.</param>
-		/// <param name="buffer">The buffer to store data in.</param>
-		/// <param name="offset">The offset at which to begin storing data.</param>
-		/// <param name="count">The number of bytes of data to store.</param>
-		/// <exception cref="ArgumentNullException">Required parameter is null</exception>
-		/// <exception cref="ArgumentOutOfRangeException"><paramref name="offset"/> and or <paramref name="count"/> are invalid.</exception>
-		public static int ReadRequestedBytes(Stream stream, byte[] buffer, int offset, int count)
+		// A helper function to share between the async and sync versions of ReadRequestedBytes
+		private static void ValidateArgumentsForRead(Stream stream, byte[] buffer, int offset, int count)
 		{
 			if (stream == null)
 			{
@@ -97,7 +89,23 @@ public static int ReadRequestedBytes(Stream stream, byte[] buffer, int offset, i
 			{
 				throw new ArgumentOutOfRangeException(nameof(count));
 			}
+		}
 
+		/// <summary>
+		/// Read as much data as possible from a <see cref="Stream"/>", up to the requested number of bytes
+		/// </summary>
+		/// <param name="stream">The stream to read data from.</param>
+		/// <param name="buffer">The buffer to store data in.</param>
+		/// <param name="offset">The offset at which to begin storing data.</param>
+		/// <param name="count">The number of bytes of data to store.</param>
+		/// <exception cref="ArgumentNullException">Required parameter is null</exception>
+		/// <exception cref="ArgumentOutOfRangeException"><paramref name="offset"/> and or <paramref name="count"/> are invalid.</exception>
+		public static int ReadRequestedBytes(Stream stream, byte[] buffer, int offset, int count)
+		{
+			// Common validation function
+			ValidateArgumentsForRead(stream, buffer, offset, count);
+
+			// read the data using Read
 			int totalReadCount = 0;
 			while (count > 0)
 			{
@@ -114,6 +122,38 @@ public static int ReadRequestedBytes(Stream stream, byte[] buffer, int offset, i
 			return totalReadCount;
 		}
 
+		/// <summary>
+		/// Read as much data as possible from a <see cref="Stream"/>", up to the requested number of bytes
+		/// </summary>
+		/// <param name="stream">The stream to read data from.</param>
+		/// <param name="buffer">The buffer to store data in.</param>
+		/// <param name="offset">The offset at which to begin storing data.</param>
+		/// <param name="count">The number of bytes of data to store.</param>
+		/// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
+		/// <exception cref="ArgumentNullException">Required parameter is null</exception>
+		/// <exception cref="ArgumentOutOfRangeException"><paramref name="offset"/> and or <paramref name="count"/> are invalid.</exception>
+		public static async Task<int> ReadRequestedBytesAsync(Stream stream, byte[] buffer, int offset, int count, CancellationToken cancellationToken)
+		{
+			// Common validation function
+			ValidateArgumentsForRead(stream, buffer, offset, count);
+
+			// read the data using ReadAsync
+			int totalReadCount = 0;
+			while (count > 0)
+			{
+				int readCount = await stream.ReadAsync(buffer, offset, count, cancellationToken).ConfigureAwait(false);
+				if (readCount <= 0)
+				{
+					break;
+				}
+				offset += readCount;
+				count -= readCount;
+				totalReadCount += readCount;
+			}
+
+			return totalReadCount;
+		}
+
 		/// <summary>
 		/// Copy the contents of one <see cref="Stream"/> to another.
 		/// </summary>

src/ICSharpCode.SharpZipLib/Encryption/ZipAESStream.cs

@@ -67,6 +67,44 @@ public ZipAESStream(Stream stream, ZipAESTransform transform, CryptoStreamMode m
 		/// and advances the position within the stream by the number of bytes read.
 		/// </summary>
 		public override int Read(byte[] buffer, int offset, int count)
+		{
+			// If we have buffered data, read that first
+			int nBytes = ReadDataFromBuffer(buffer, ref offset, ref count);
+
+			// If we've read the requested amount of data, return just that
+			if (count == 0)
+				return nBytes;
+
+			// Read more data from the input, if available
+			if (_slideBuffer != null)
+			{
+				nBytes += ReadAndTransformAsync(buffer, offset, count, false, default).GetAwaiter().GetResult();
+			}
+
+			return nBytes;
+		}
+
+		/// <inheritdoc/>
+		public override async Task<int> ReadAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)
+		{
+			// If we have buffered data, read that first
+			int nBytes = ReadDataFromBuffer(buffer, ref offset, ref count);
+
+			// If we've read the requested amount of data, return just that
+			if (count == 0)
+				return nBytes;
+
+			// Read more data from the input, if available
+			if (_slideBuffer != null)
+			{
+				nBytes += await ReadAndTransformAsync(buffer, offset, count, true, cancellationToken).ConfigureAwait(false);
+			}
+
+			return nBytes;
+		}
+
+		// Read up to the requested amount of data from the buffer
+		private int ReadDataFromBuffer(byte[] buffer, ref int offset, ref int count)
 		{
 			// Nothing to do
 			if (count == 0)
@@ -78,30 +116,15 @@ public override int Read(byte[] buffer, int offset, int count)
 			{
 				nBytes = ReadBufferedData(buffer, offset, count);
 
-				// Read all requested data from the buffer
-				if (nBytes == count)
-					return nBytes;
-
 				offset += nBytes;
 				count -= nBytes;
 			}
 
-			// Read more data from the input, if available
-			if (_slideBuffer != null)
-				nBytes += ReadAndTransform(buffer, offset, count);
-
 			return nBytes;
 		}
 
-		/// <inheritdoc/>
-		public override Task<int> ReadAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)
-		{
-			var readCount = Read(buffer, offset, count);
-			return Task.FromResult(readCount);
-		}
-
 		// Read data from the underlying stream and decrypt it
-		private int ReadAndTransform(byte[] buffer, int offset, int count)
+		private async Task<int> ReadAndTransformAsync(byte[] buffer, int offset, int count, bool useAsync, CancellationToken cancellationToken)
 		{
 			int nBytes = 0;
 			while (nBytes < count)
@@ -126,7 +149,11 @@ private int ReadAndTransform(byte[] buffer, int offset, int count)
 					_slideBufFreePos -= _slideBufStartPos;      // Note the -=
 					_slideBufStartPos = 0;
 				}
-				int obtained = StreamUtils.ReadRequestedBytes(_stream, _slideBuffer, _slideBufFreePos, lengthToRead);
+
+				int obtained = useAsync ?
+						await StreamUtils.ReadRequestedBytesAsync(_stream, _slideBuffer, _slideBufFreePos, lengthToRead, cancellationToken).ConfigureAwait(false) :
+						StreamUtils.ReadRequestedBytes(_stream, _slideBuffer, _slideBufFreePos, lengthToRead);
+
 				_slideBufFreePos += obtained;
 
 				// Recalculate how much data we now have