Summary

Represent errors that occur during script execution.

Namespace

Interfaces

Base Types

graph BT Type-->Base0["Exception"] Base0-->Base1["object"] Type-.->Interface0["ISerializable"] Type["CakeException"] class Type type-node

Syntax

public sealed class CakeException : Exception, ISerializable

Name	Summary
CakeException()	Initializes a new instance of the `CakeException` class.
CakeException(int, string, Exception)	Initializes a new instance of the `CakeException` class.
CakeException(int, string)	Initializes a new instance of the `CakeException` class.
CakeException(int)	Initializes a new instance of the `CakeException` class.
CakeException(string, Exception)	Initializes a new instance of the `CakeException` class.
CakeException(string)	Initializes a new instance of the `CakeException` class.

Name	Value	Summary
ExitCode	int	Gets custom exit code.

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