WarpSettings Class

Summary

Contains the settings used by Cake.Warp.WarpRunner.
Assembly
Cake.Warp.dll
Namespace
Cake.Warp
Base Types
  • ToolSettings
graph BT Type-->Base0["ToolSettings"] Type["WarpSettings"] class Type type-node

Syntax

public sealed class WarpSettings : ToolSettings

Remarks

All properties are required (except Platform as this as just an alias for Architecture).

Constructors

Name Summary
WarpSettings() Initializes a new instance of the WarpSettings class, with ToolPath set to the extracted warp binary file.

Properties

Name Value Summary
Architecture WarpPlatforms
Gets or sets the platform and architecture to create the self-contained application for.
ExecutableName string
Gets or sets the name of the executable to run after the the created application is being executed by a user.
InputDirectory DirectoryPath
Gets or sets the directory that will be packed into the self-contained application.
OutputFilePath FilePath
Gets or sets the output path to where the self-contained application should be created.
Platform WarpPlatforms
Gets or sets the platform and architecture to create the self-contained application for.

Extension Methods

Name Value Summary
Dump<WarpSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<WarpSettings>(WarpSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<WarpSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<WarpSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<WarpSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<WarpSettings>(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
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin