/// <summary>
/// Create a <c>DeflateStream</c> using the specified <c>CompressionMode</c> and the
/// specified <c>CompressionLevel</c>, and explicitly specify whether the stream should be
/// left open after Deflation or Inflation.
/// </summary>
/// <remarks>
/// <para>
/// When mode is <c>CompressionMode.Decompress</c>, the level parameter is ignored.
/// </para>
/// <para>
/// This constructor allows the application to request that the captive stream remain open
/// after the deflation or inflation occurs. By default, after <c>Close()</c> is called on
/// the stream, the captive stream is also closed. In some cases this is not desired, for
/// example if the stream is a <see cref="System.IO.MemoryStream"/> that will be re-read
/// after compression. Specify true for the <paramref name="leaveOpen"/> parameter to leave
/// the stream open.
/// </para>
/// </remarks>
/// <example>
/// This example shows how to use a <c>DeflateStream</c> to compress data from a file, and
/// store the compressed data into another file.
/// <code>
/// using (var output = System.IO.File.Create(fileToCompress + ".deflated"))
/// {
/// using (System.IO.Stream input = System.IO.File.OpenRead(fileToCompress))
/// {
/// using (Stream compressor = new DeflateStream(output, CompressionMode.Compress, CompressionLevel.BestCompression, true))
/// {
/// byte[] buffer = new byte[WORKING_BUFFER_SIZE];
/// int n= -1;
/// while (n != 0)
/// {
/// if (n > 0)
/// compressor.Write(buffer, 0, n);
/// n= input.Read(buffer, 0, buffer.Length);
/// }
/// }
/// }
/// // can write additional data to the output stream here
/// }
/// </code>
/// <code lang="VB">
/// Using output As FileStream = File.Create(fileToCompress & ".deflated")
/// Using input As Stream = File.OpenRead(fileToCompress)
/// Using compressor As Stream = New DeflateStream(output, CompressionMode.Compress, CompressionLevel.BestCompression, True)
/// Dim buffer As Byte() = New Byte(4096) {}
/// Dim n As Integer = -1
/// Do While (n <> 0)
/// If (n > 0) Then
/// compressor.Write(buffer, 0, n)
/// End If
/// n = input.Read(buffer, 0, buffer.Length)
/// Loop
/// End Using
/// End Using
/// ' can write additional data to the output stream here.
/// End Using
/// </code>
/// </example>
/// <param name="stream">The stream which will be read or written.</param>
/// <param name="mode">Indicates whether the DeflateStream will compress or decompress.</param>
/// <param name="leaveOpen">
/// true if the application would like the stream to remain open after inflation/deflation.
/// </param>
/// <param name="level">A tuning knob to trade speed for effectiveness.</param>
public DeflateStream(Stream stream, CompressionMode mode, CompressionLevel level, bool leaveOpen)
{
this._innerStream = stream;
this._baseStream = new ZlibBaseStream(stream, mode, level, ZlibStreamFlavor.DEFLATE, leaveOpen);
}
/// <summary>
/// Create a <c>ZlibStream</c> using the specified <c>CompressionMode</c> and the specified
/// <c>CompressionLevel</c>, and explicitly specify whether the stream should be left open
/// after Deflation or Inflation.
/// </summary>
/// <remarks>
/// <para>
/// This constructor allows the application to request that the captive stream remain open
/// after the deflation or inflation occurs. By default, after <c>Close()</c> is called on
/// the stream, the captive stream is also closed. In some cases this is not desired, for
/// example if the stream is a <see cref="System.IO.MemoryStream"/> that will be re-read
/// after compression. Specify true for the <paramref name="leaveOpen"/> parameter to leave
/// the stream open.
/// </para>
/// <para>
/// When mode is <c>CompressionMode.Decompress</c>, the level parameter is ignored.
/// </para>
/// </remarks>
/// <example>
/// This example shows how to use a ZlibStream to compress the data from a file, and store
/// the result into another file. The filestream remains open to allow additional data to be
/// written to it.
/// <code>
/// using (var output = System.IO.File.Create(fileToCompress + ".zlib"))
/// {
/// using (System.IO.Stream input = System.IO.File.OpenRead(fileToCompress))
/// {
/// using (Stream compressor = new ZlibStream(output, CompressionMode.Compress, CompressionLevel.BestCompression, true))
/// {
/// byte[] buffer = new byte[WORKING_BUFFER_SIZE];
/// int n;
/// while ((n= input.Read(buffer, 0, buffer.Length)) != 0)
/// {
/// compressor.Write(buffer, 0, n);
/// }
/// }
/// }
/// // can write additional data to the output stream here
/// }
/// </code>
/// <code lang="VB">
/// Using output As FileStream = File.Create(fileToCompress & ".zlib")
/// Using input As Stream = File.OpenRead(fileToCompress)
/// Using compressor As Stream = New ZlibStream(output, CompressionMode.Compress, CompressionLevel.BestCompression, True)
/// Dim buffer As Byte() = New Byte(4096) {}
/// Dim n As Integer = -1
/// Do While (n <> 0)
/// If (n > 0) Then
/// compressor.Write(buffer, 0, n)
/// End If
/// n = input.Read(buffer, 0, buffer.Length)
/// Loop
/// End Using
/// End Using
/// ' can write additional data to the output stream here.
/// End Using
/// </code>
/// </example>
/// <param name="stream">The stream which will be read or written.</param>
/// <param name="mode">Indicates whether the ZlibStream will compress or decompress.</param>
/// <param name="leaveOpen">
/// true if the application would like the stream to remain open after inflation/deflation.
/// </param>
/// <param name="level">
/// A tuning knob to trade speed for effectiveness. This parameter is effective only when
/// mode is <c>CompressionMode.Compress</c>.
/// </param>
public ZlibStream(Stream stream, CompressionMode mode, CompressionLevel level, bool leaveOpen)
{
this._baseStream = new ZlibBaseStream(stream, mode, level, ZlibStreamFlavor.ZLIB, leaveOpen);
}
