This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.Compression.

Summary

Provides a GZip class.

Assembly

Cake.Compression.dll

Namespace

Cake.Compression.Classes

Base Types

Object
CompressionBase

graph BT Type-->Base0["CompressionBase"] click Base0 "/api/Cake.Compression.Classes/CompressionBase" Base0-->Base1["Object"] Type["GZip"] class Type type-node

Syntax

public sealed class GZip : CompressionBase

Attributes

Type	Description
NullableContextAttribute
NullableAttribute

Constructors

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

Properties

Name	Value	Summary
Comparison	StringComparison	Gets the string comparison. Inherited from CompressionBase
Environment	ICakeEnvironment	Gets the environment. Inherited from CompressionBase
FileSystem	IFileSystem	Gets the file system. Inherited from CompressionBase
Log	ICakeLog	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.
Decompress(FilePath, DirectoryPath)	void	Decompress the specified GZip Tar file.
GetRelativeFilePath(DirectoryPath, FilePath)	FilePath	Gets a relative file path. Inherited from CompressionBase

Extension Methods

Name	Value	Summary
Dump<GZip>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<GZip>(GZip[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<GZip>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
NotNull<GZip>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
ThrowIfNull<GZip>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<GZip>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin