DeflateStream Class

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Provides methods and properties for compressing and decompressing streams by using the Deflate algorithm.

Namespace:   System.IO.Compression
Assembly:  System (in System.dll)

System.Object
  System.MarshalByRefObject
    System.IO.Stream
      System.IO.Compression.DeflateStream

C#
C++
F#
VB
Copy 
public class DeflateStream : Stream

NameDescription
System_CAPS_pubmethodDeflateStream(Stream, CompressionLevel)

Initializes a new instance of the DeflateStream class by using the specified stream and compression level.

System_CAPS_pubmethodDeflateStream(Stream, CompressionLevel, Boolean)

Initializes a new instance of the DeflateStream class by using the specified stream and compression level, and optionally leaves the stream open.

System_CAPS_pubmethodDeflateStream(Stream, CompressionMode)

Initializes a new instance of the DeflateStream class by using the specified stream and compression mode.

System_CAPS_pubmethodDeflateStream(Stream, CompressionMode, Boolean)

Initializes a new instance of the DeflateStream class by using the specified stream and compression mode, and optionally leaves the stream open.

NameDescription
System_CAPS_pubpropertyBaseStream

Gets a reference to the underlying stream.

System_CAPS_pubpropertyCanRead

Gets a value indicating whether the stream supports reading while decompressing a file.(Overrides Stream.CanRead.)

System_CAPS_pubpropertyCanSeek

Gets a value indicating whether the stream supports seeking.(Overrides Stream.CanSeek.)

System_CAPS_pubpropertyCanTimeout

Gets a value that determines whether the current stream can time out.(Inherited from Stream.)

System_CAPS_pubpropertyCanWrite

Gets a value indicating whether the stream supports writing.(Overrides Stream.CanWrite.)

System_CAPS_pubpropertyLength

This property is not supported and always throws a NotSupportedException.(Overrides Stream.Length.)

System_CAPS_pubpropertyPosition

This property is not supported and always throws a NotSupportedException.(Overrides Stream.Position.)

System_CAPS_pubpropertyReadTimeout

Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out. (Inherited from Stream.)

System_CAPS_pubpropertyWriteTimeout

Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out. (Inherited from Stream.)

NameDescription
System_CAPS_pubmethodBeginRead(Byte[], Int32, Int32, AsyncCallback, Object)

Begins an asynchronous read operation. (Consider using the ReadAsync method instead; see the Remarks section.)(Overrides Stream.BeginRead(Byte[], Int32, Int32, AsyncCallback, Object).)

System_CAPS_pubmethodBeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)

Begins an asynchronous write operation. (Consider using the Stream.WriteAsync method instead; see the Remarks section.)(Overrides Stream.BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object).)

System_CAPS_pubmethodClose()

Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. Instead of calling this method, ensure that the stream is properly disposed.(Inherited from Stream.)

System_CAPS_pubmethodCopyTo(Stream)

Reads the bytes from the current stream and writes them to another stream.(Inherited from Stream.)

System_CAPS_pubmethodCopyTo(Stream, Int32)

Reads the bytes from the current stream and writes them to another stream, using a specified buffer size.(Inherited from Stream.)

System_CAPS_pubmethodCopyToAsync(Stream)

Asynchronously reads the bytes from the current stream and writes them to another stream.(Inherited from Stream.)

System_CAPS_pubmethodCopyToAsync(Stream, Int32)

Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size.(Inherited from Stream.)

System_CAPS_pubmethodCopyToAsync(Stream, Int32, CancellationToken)

Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token.(Inherited from Stream.)

System_CAPS_pubmethodCreateObjRef(Type)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodCreateWaitHandle()

Obsolete. Allocates a WaitHandle object.(Inherited from Stream.)

System_CAPS_pubmethodDispose()

Releases all resources used by the Stream.(Inherited from Stream.)

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the DeflateStream and optionally releases the managed resources.(Overrides Stream.Dispose(Boolean).)

System_CAPS_pubmethodEndRead(IAsyncResult)

Waits for the pending asynchronous read to complete. (Consider using the ReadAsync method instead; see the Remarks section.)(Overrides Stream.EndRead(IAsyncResult).)

System_CAPS_pubmethodEndWrite(IAsyncResult)

Ends an asynchronous write operation. (Consider using the Stream.WriteAsync method instead; see the Remarks section.)(Overrides Stream.EndWrite(IAsyncResult).)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodFlush()

The current implementation of this method has no functionality.(Overrides Stream.Flush().)

System_CAPS_pubmethodFlushAsync()

Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device.(Inherited from Stream.)

System_CAPS_pubmethodFlushAsync(CancellationToken)

Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests.(Inherited from Stream.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone(Boolean)

Creates a shallow copy of the current MarshalByRefObject object.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodObjectInvariant()

Obsolete. This API supports the product infrastructure and is not intended to be used directly from your code. Provides support for a Contract.(Inherited from Stream.)

System_CAPS_pubmethodRead(Byte[], Int32, Int32)

Reads a number of decompressed bytes into the specified byte array.(Overrides Stream.Read(Byte[], Int32, Int32).)

System_CAPS_pubmethodReadAsync(Byte[], Int32, Int32)

Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.(Inherited from Stream.)

System_CAPS_pubmethodReadAsync(Byte[], Int32, Int32, CancellationToken)

Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.(Inherited from Stream.)

System_CAPS_pubmethodReadByte()

Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.(Inherited from Stream.)

System_CAPS_pubmethodSeek(Int64, SeekOrigin)

This operation is not supported and always throws a NotSupportedException.(Overrides Stream.Seek(Int64, SeekOrigin).)

System_CAPS_pubmethodSetLength(Int64)

This operation is not supported and always throws a NotSupportedException.(Overrides Stream.SetLength(Int64).)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodWrite(Byte[], Int32, Int32)

Writes compressed bytes to the underlying stream from the specified byte array.(Overrides Stream.Write(Byte[], Int32, Int32).)

System_CAPS_pubmethodWriteAsync(Byte[], Int32, Int32)

Asynchronously writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.(Inherited from Stream.)

System_CAPS_pubmethodWriteAsync(Byte[], Int32, Int32, CancellationToken)

Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.(Inherited from Stream.)

System_CAPS_pubmethodWriteByte(Byte)

Writes a byte to the current position in the stream and advances the position within the stream by one byte.(Inherited from Stream.)

This class represents the Deflate algorithm, which is an industry-standard algorithm for lossless file compression and decompression. Starting with the .NET Framework 4.5, the DeflateStream class uses the zlib library. As a result, it provides a better compression algorithm and, in most cases, a smaller compressed file than it provides in earlier versions of the .NET Framework.

This class does not inherently provide functionality for adding files to or extracting files from zip archives. To work with zip archives, use the ZipArchive and the ZipArchiveEntry classes.

The DeflateStream class uses the same compression algorithm as the gzip data format used by the GZipStream class.

The compression functionality in DeflateStream and GZipStream is exposed as a stream. Data is read on a byte-by-byte basis, so it is not possible to perform multiple passes to determine the best method for compressing entire files or large blocks of data. The DeflateStream and GZipStream classes are best used on uncompressed sources of data. If the source data is already compressed, using these classes may actually increase the size of the stream.

The following example shows how to use the DeflateStream class to compress and decompress a directory of files.

C#
VB
Copy 
using System;
using System.IO;
using System.IO.Compression;

public class Program
{
    static string directoryPath = @"c:\temp";
    public static void Main()
    {

        DirectoryInfo directorySelected = new DirectoryInfo(directoryPath);
           Compress(directorySelected);


        foreach (FileInfo fileToDecompress in directorySelected.GetFiles("*.cmp"))
        {
            Decompress(fileToDecompress);
        }
    }

    public static void Compress(DirectoryInfo directorySelected)
    {


        foreach (FileInfo file in directorySelected.GetFiles("*.xml"))
        using (FileStream originalFileStream = file.OpenRead())
        {
            if ((File.GetAttributes(file.FullName) & FileAttributes.Hidden)
                != FileAttributes.Hidden & file.Extension != ".cmp")
            {
                using (FileStream compressedFileStream = File.Create(file.FullName + ".cmp"))
                {
                    using (DeflateStream compressionStream = new DeflateStream(compressedFileStream, CompressionMode.Compress))
                    {
                        originalFileStream.CopyTo(compressionStream);
                    }
                }

                FileInfo info = new FileInfo(directoryPath + "\\" + file.Name + ".cmp");
                Console.WriteLine("Compressed {0} from {1} to {2} bytes.", file.Name, file.Length, info.Length);
            }
        }
    }

    public static void Decompress(FileInfo fileToDecompress)
    {
        using (FileStream originalFileStream = fileToDecompress.OpenRead())
        {
            string currentFileName = fileToDecompress.FullName;
            string newFileName = currentFileName.Remove(currentFileName.Length - fileToDecompress.Extension.Length);

            using (FileStream decompressedFileStream = File.Create(newFileName))
        	{
                using (DeflateStream decompressionStream = new DeflateStream(originalFileStream, CompressionMode.Decompress))
        	    {
                    decompressionStream.CopyTo(decompressedFileStream);
                    Console.WriteLine("Decompressed: {0}", fileToDecompress.Name);
        	    }
        	}
        }
    }
}

Universal Windows Platform
Available since 8
.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Windows Phone
Available since 8.1

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: