Class CompressionUtility

This utility class is designed to make System.IO.Stream related compression operations easier to work with.

Inheritance

System.Object

CompressionUtility

Namespace: Cuemon.IO.Compression

Assembly: Cuemon.IO.dll

Syntax

public static class CompressionUtility

Methods

| Improve this Doc

CompressStream(Stream)

Compresses the source stream using the Deflate algorithm.

Declaration

public static Stream CompressStream(Stream source)

Parameters

Type	Name	Description
System.IO.Stream	source	The source stream to compress.

Returns

Type	Description
System.IO.Stream	A compressed System.IO.Stream of the `source`.

| Improve this Doc

CompressStream(Stream, CompressionType)

Compresses the source stream using the specified compressionType algorithm.

Declaration

public static Stream CompressStream(Stream source, CompressionType compressionType)

Parameters

Type	Name	Description
System.IO.Stream	source	The source stream to compress.
CompressionType	compressionType	The compression algorithm to use for the compression.

Returns

Type	Description
System.IO.Stream	A compressed System.IO.Stream of the `source`.

| Improve this Doc

CompressStream(Stream, CompressionType, Int32)

Compresses the source stream using the specified compressionType algorithm.

Declaration

public static Stream CompressStream(Stream source, CompressionType compressionType, int bufferSize)

Parameters

Type	Name	Description
System.IO.Stream	source	The source stream to compress.
CompressionType	compressionType	The compression algorithm to use for the compression.
System.Int32	bufferSize	The size of the buffer. This value must be greater than zero. The default size is 2048.

Returns

Type	Description
System.IO.Stream	A compressed System.IO.Stream of the `source`.

| Improve this Doc

DecompressStream(Stream)

Decompresses the source stream using the Deflate algorithm.

Declaration

public static Stream DecompressStream(Stream source)

Parameters

Type	Name	Description
System.IO.Stream	source	The source stream to decompress.

Returns

Type	Description
System.IO.Stream	A decompressed System.IO.Stream of the `source`.

| Improve this Doc

DecompressStream(Stream, CompressionType)

Decompresses the source stream using the specified compressionType algorithm.

Declaration

public static Stream DecompressStream(Stream source, CompressionType compressionType)

Parameters

Type	Name	Description
System.IO.Stream	source	The source stream to decompress.
CompressionType	compressionType	The compression algorithm to use for the decompression.

Returns

Type	Description
System.IO.Stream	A decompressed System.IO.Stream of the `source`.

| Improve this Doc

DecompressStream(Stream, CompressionType, Int32)

Decompresses the source stream using the specified compressionType algorithm.

Declaration

public static Stream DecompressStream(Stream source, CompressionType compressionType, int bufferSize)

Parameters

Type	Name	Description
System.IO.Stream	source	The source stream to decompress.
CompressionType	compressionType	The compression algorithm to use for the decompression.
System.Int32	bufferSize	The size of the buffer. This value must be greater than zero. The default size is 2048.

Returns

Type	Description
System.IO.Stream	A decompressed System.IO.Stream of the `source`.