Merge branch 'feature/binary_parser' into develop

Resolves #113

Author: Jericho

.config/dotnet-tools.json

@@ -3,7 +3,7 @@
   "isRoot": true,
   "tools": {
     "cake.tool": {
-      "version": "2.3.0",
+      "version": "3.0.0",
       "commands": [
         "dotnet-cake"
       ]

Source/HttpMultipartParser.UnitTests/ParserScenarios/SmallData.cs

@@ -60,7 +60,7 @@ public void SmallDataTest()
 			{
 				// The boundry is missing the first two -- in accordance with the multipart
 				// spec. (A -- is added by the parser, this boundry is what would be sent in the
-				// requset header)
+				// request header)
 				var parser = MultipartFormDataParser.Parse(stream, "---------------------------265001916915724");
 				Assert.True(_testCase.Validate(parser));
 			}

Source/HttpMultipartParser/BinaryStreamStack.cs

@@ -54,7 +54,7 @@ public class BinaryStreamStack
 		///     encoding of UTF8.
 		/// </summary>
 		public BinaryStreamStack()
-			: this(Encoding.UTF8)
+			: this(Constants.DefaultEncoding)
 		{
 		}
 

Source/HttpMultipartParser/Constants.cs

@@ -0,0 +1,27 @@
+using System.Text;
+
+namespace HttpMultipartParser
+{
+	internal static class Constants
+	{
+		/// <summary>
+		///     The default buffer size.
+		/// </summary>
+		/// <remarks>
+		///     4096 is the optimal buffer size as it matches the internal buffer of a StreamReader
+		///     See: http://stackoverflow.com/a/129318/203133
+		///     See: http://msdn.microsoft.com/en-us/library/9kstw824.aspx (under remarks).
+		/// </remarks>
+		internal const int DefaultBufferSize = 4096;
+
+		/// <summary>
+		/// The mimetypes that are considered a file by default.
+		/// </summary>
+		internal static readonly string[] DefaultBinaryMimeTypes = { "application/octet-stream" };
+
+		/// <summary>
+		/// The default encoding used by the parser when developer does not specify the encoding.
+		/// </summary>
+		internal static readonly Encoding DefaultEncoding = Encoding.UTF8;
+	}
+}

Source/HttpMultipartParser/Delegates.cs

@@ -0,0 +1,37 @@
+using System.Collections.Generic;
+
+namespace HttpMultipartParser
+{
+	/// <summary>
+	/// The FileStreamDelegate defining functions that can handle file stream data from this parser.
+	///
+	/// Delegates can assume that the data is sequential i.e. the data received by any delegates will be
+	/// the data immediately following any previously received data.
+	/// </summary>
+	/// <param name="name">The name of the multipart data.</param>
+	/// <param name="fileName">The name of the file.</param>
+	/// <param name="contentType">The content type of the multipart data.</param>
+	/// <param name="contentDisposition">The content disposition of the multipart data.</param>
+	/// <param name="buffer">Some of the data from the file (not necessarily all of the data).</param>
+	/// <param name="bytes">The length of data in buffer.</param>
+	/// <param name="partNumber">Each chunk (or "part") in a given file is sequentially numbered, starting at zero.</param>
+	/// <param name="additionalProperties">Properties other than the "well known" ones (such as name, filename, content-type, etc.) associated with a file stream.</param>
+	public delegate void FileStreamDelegate(string name, string fileName, string contentType, string contentDisposition, byte[] buffer, int bytes, int partNumber, IDictionary<string, string> additionalProperties);
+
+	/// <summary>
+	/// The StreamClosedDelegate defining functions that can handle stream being closed.
+	/// </summary>
+	public delegate void StreamClosedDelegate();
+
+	/// <summary>
+	/// The ParameterDelegate defining functions that can handle multipart parameter data.
+	/// </summary>
+	/// <param name="part">The parsed parameter part.</param>
+	public delegate void ParameterDelegate(ParameterPart part);
+
+	/// <summary>
+	/// The BinaryParameterDelegate defining functions that can handle multipart parameter data.
+	/// </summary>
+	/// <param name="binaryPart">The parsed parameter part.</param>
+	public delegate void BinaryParameterDelegate(ParameterPartBinary binaryPart);
+}

Source/HttpMultipartParser/IMultipartFormBinaryDataParser.cs

@@ -0,0 +1,25 @@
+using System.Collections.Generic;
+
+namespace HttpMultipartParser
+{
+	/// <summary>
+	///     Provides methods to parse a
+	///     <see href="http://www.ietf.org/rfc/rfc2388.txt">
+	///         <c>multipart/form-data</c>
+	///     </see>
+	///     stream into it's parameters and file data.
+	/// </summary>
+	public interface IMultipartFormBinaryDataParser
+	{
+		/// <summary>
+		///     Gets the mapping of parameters parsed files. The name of a given field
+		///     maps to the parsed file data.
+		/// </summary>
+		IReadOnlyList<FilePart> Files { get; }
+
+		/// <summary>
+		///     Gets the parameters. Several ParameterPartBinary may share the same name.
+		/// </summary>
+		IReadOnlyList<ParameterPartBinary> Parameters { get; }
+	}
+}

Source/HttpMultipartParser/IStreamingBinaryMultipartFormDataParser.cs

@@ -0,0 +1,42 @@
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace HttpMultipartParser
+{
+	/// <summary>
+	///     Provides methods to parse a
+	///     <see href="http://www.ietf.org/rfc/rfc2388.txt">
+	///         <c>multipart/form-data</c>
+	///     </see>
+	///     stream into it's parameters and file data.
+	/// </summary>
+	public interface IStreamingBinaryMultipartFormDataParser
+	{
+		/// <summary>
+		/// Gets or sets the FileHandler. Delegates attached to this property will receive sequential file stream data from this parser.
+		/// </summary>
+		FileStreamDelegate FileHandler { get; set; }
+
+		/// <summary>
+		/// Gets or sets the ParameterHandler. Delegates attached to this property will receive parameter data.
+		/// </summary>
+		BinaryParameterDelegate ParameterHandler { get; set; }
+
+		/// <summary>
+		/// Gets or sets the StreamClosedHandler. Delegates attached to this property will be notified when the source stream is exhausted.
+		/// </summary>
+		StreamClosedDelegate StreamClosedHandler { get; set; }
+
+		/// <summary>
+		/// Execute the parser. This should be called after all handlers have been set.
+		/// </summary>
+		void Run();
+
+		/// <summary>
+		/// Execute the parser asynchronously. This should be called after all handlers have been set.
+		/// </summary>
+		/// <param name="cancellationToken">The cancellation token.</param>
+		/// <returns>The asynchronous task.</returns>
+		Task RunAsync(CancellationToken cancellationToken = default);
+	}
+}

Source/HttpMultipartParser/IStreamingMultipartFormDataParser.cs

@@ -1,36 +1,8 @@
-using System.Collections.Generic;
 using System.Threading;
 using System.Threading.Tasks;
 
 namespace HttpMultipartParser
 {
-	/// <summary>
-	/// The FileStreamDelegate defining functions that can handle file stream data from this parser.
-	///
-	/// Delegates can assume that the data is sequential i.e. the data received by any delegates will be
-	/// the data immediately following any previously received data.
-	/// </summary>
-	/// <param name="name">The name of the multipart data.</param>
-	/// <param name="fileName">The name of the file.</param>
-	/// <param name="contentType">The content type of the multipart data.</param>
-	/// <param name="contentDisposition">The content disposition of the multipart data.</param>
-	/// <param name="buffer">Some of the data from the file (not necessarily all of the data).</param>
-	/// <param name="bytes">The length of data in buffer.</param>
-	/// <param name="partNumber">Each chunk (or "part") in a given file is sequentially numbered, starting at zero.</param>
-	/// <param name="additionalProperties">Properties other than the "well known" ones (such as name, filename, content-type, etc.) associated with a file stream.</param>
-	public delegate void FileStreamDelegate(string name, string fileName, string contentType, string contentDisposition, byte[] buffer, int bytes, int partNumber, IDictionary<string, string> additionalProperties);
-
-	/// <summary>
-	/// The StreamClosedDelegate defining functions that can handle stream being closed.
-	/// </summary>
-	public delegate void StreamClosedDelegate();
-
-	/// <summary>
-	/// The ParameterDelegate defining functions that can handle multipart parameter data.
-	/// </summary>
-	/// <param name="part">The parsed parameter part.</param>
-	public delegate void ParameterDelegate(ParameterPart part);
-
 	/// <summary>
 	///     Provides methods to parse a
 	///     <see href="http://www.ietf.org/rfc/rfc2388.txt">