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 CompressionBase class.

Assembly

Cake.Compression.dll

Namespace

Cake.Compression.Classes

Base Types

Object

Derived Types

graph BT Type-->Base0["Object"] Type["CompressionBase"] class Type type-node Derived0["GZip"]-->Type click Derived0 "/api/Cake.Compression.Classes/GZip" Derived1["Zip"]-->Type click Derived1 "/api/Cake.Compression.Classes/Zip" Derived2["BZip2"]-->Type click Derived2 "/api/Cake.Compression.Classes/BZip2"

Syntax

public abstract class CompressionBase

Attributes

Type	Description
NullableContextAttribute
NullableAttribute

Constructors

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

Properties

Name	Value	Summary
Comparison	StringComparison	Gets the string comparison.
Environment	ICakeEnvironment	Gets the environment.
FileSystem	IFileSystem	Gets the file system.
Log	ICakeLog	Gets the log.

Methods

Name	Value	Summary
Compress(DirectoryPath, FilePath, IEnumerable<FilePath>, int)	void	Create a archive of the specified files.
Decompress(FilePath, DirectoryPath)	void	Decompress the specified archive.
GetRelativeFilePath(DirectoryPath, FilePath)	FilePath	Gets a relative file path.

Extension Methods

Name	Value	Summary
Dump<CompressionBase>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<CompressionBase>(CompressionBase[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<CompressionBase>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<CompressionBase>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<CompressionBase>(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<CompressionBase>(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