GZip Class

Summary

Provides a GZip class.
Assembly
Cake.Compression.dll
Namespace
Cake.Compression.Classes
Base Types
graph BT Type-->Base0["CompressionBase"] click Base0 "/api/Cake.Compression.Classes/CompressionBase" Base0-->Base1["Object"] Type["GZip"] class Type type-node

Syntax

public class GZip : CompressionBase

Constructors

Name Summary
GZip(IFileSystem, ICakeEnvironment, ICakeLog) Initializes a new instance of the GZip class.

Fields

Name Constant Value Summary
comparison
Gets the string comparison.
Inherited from CompressionBase
environment
Gets the environment.
Inherited from CompressionBase
fileSystem
Gets the file system.
Inherited from CompressionBase
log
Gets the log.
Inherited from CompressionBase

Methods

Name Value Summary
Compress(DirectoryPath, FilePath, IEnumerable<FilePath>, int) void
Create a GZip Tar archive of the specified files.
GetRelativeFilePath(DirectoryPath, FilePath) FilePath
Gets a relative file path.
Inherited from CompressionBase
Uncompress(FilePath, DirectoryPath) void
Uncompress the specified GZip Tar file.

Extension Methods

Name Value Summary
Dump<GZip>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<GZip>(GZip[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<GZip>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<GZip>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<GZip>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<GZip>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin