Summary
Utility for building process arguments.
- Namespace
- Cake
.Core .IO - Interfaces
-
- IReadOnlyCollection
<IProcessArgument> - IEnumerable
<IProcessArgument> - IEnumerable
- IReadOnlyCollection
- Base Types
-
- object
graph BT
Type-->Base0["object"]
Type-.->Interface0["IReadOnlyCollection<IProcessArgument>"]
Type-.->Interface1["IEnumerable<IProcessArgument>"]
Type-.->Interface2["IEnumerable"]
Type["ProcessArgumentBuilder"]
class Type type-node
Syntax
public sealed class ProcessArgumentBuilder : IReadOnlyCollection<IProcessArgument>,
IEnumerable<IProcessArgument>, IEnumerable
Constructors
Name | Summary |
---|---|
Process |
Initializes a new instance of the ProcessArgumentBuilder class.
|
Properties
Name | Value | Summary |
---|---|---|
Count | int |
Gets the number of arguments contained in the
ProcessArgumentBuilder .
|
Methods
Name | Value | Summary |
---|---|---|
Append |
void |
Appends an argument.
|
AppendRange |
void |
Appends arguments.
|
Clear |
void |
Clears all arguments from the builder.
|
FilterUnsafe |
string |
Tries to filer any unsafe arguments from string.
|
FromString |
Process |
Performs a conversion from
string to ProcessArgumentBuilder .
static
|
FromStringQuoted |
Process |
Performs a conversion from
string to ProcessArgumentBuilder .
static
|
FromStrings |
Process |
Performs a conversion from
IEnumerable<T> to ProcessArgumentBuilder .
static
|
FromStringsQuoted |
Process |
Performs a conversion from
IEnumerable<T> to ProcessArgumentBuilder .
static
|
Prepend |
void |
Prepends an argument.
|
PrependRange |
void |
Prepends arguments.
|
Render |
string |
Renders the arguments as a
string .
Sensitive information will be included.
|
RenderSafe |
string |
Renders the arguments as a
string .
Sensitive information will be redacted.
|
Operators
Name | Value | Summary |
---|---|---|
implicit operator |
Process |
Extension Methods
Name | Value | Summary |
---|---|---|
Append |
Process |
Formats and appends the specified text to the argument builder.
|
Append |
Process |
Appends the specified text to the argument builder.
|
Append |
void |
Adds MSBuild arguments.
|
Append |
void |
Adds MSBuild arguments.
|
AppendQuoted |
Process |
Quotes and appends the specified argument to the argument builder.
|
AppendQuoted |
Process |
Formats, quotes and appends the specified text to the argument builder.
|
AppendQuoted |
Process |
Quotes and appends the specified text to the argument builder.
|
AppendQuotedSecret |
Process |
Quotes and appends the specified secret text to the argument builder.
|
AppendQuotedSecret |
Process |
Quotes and appends the specified secret text to the argument builder.
|
AppendQuotedSecret |
Process |
Formats, quotes and appends the specified secret text to the argument builder.
|
AppendQuotedSecret |
Process |
Quotes and appends the specified secret text to the argument builder.
|
AppendQuotedSecret |
Process |
Quotes and appends the specified secret text to the argument builder.
|
AppendSecret |
Process |
Appends the specified secret text to the argument builder.
|
AppendSecret |
Process |
Formats and appends the specified secret text to the argument builder.
|
AppendSecret |
Process |
Appends the specified secret text to the argument builder.
|
AppendSwitch |
Process |
Appends the specified switch to the argument builder.
|
AppendSwitch |
Process |
Appends the specified switch to the argument builder.
|
AppendSwitchQuoted |
Process |
Quotes and appends the specified argument to the argument builder.
|
AppendSwitchQuoted |
Process |
Quotes and appends the specified argument to the argument builder.
|
AppendSwitchQuoted |
Process |
Quotes and appends the specified text to the argument builder.
|
AppendSwitchQuoted |
Process |
Quotes and appends the specified text to the argument builder.
|
Append |
Process |
Quotes and appends the specified secret text to the argument builder.
|
Append |
Process |
Quotes and appends the specified secret text to the argument builder.
|
AppendSwitchSecret |
Process |
Appends the specified secret text to the argument builder.
|
AppendSwitchSecret |
Process |
Appends the specified secret text to the argument builder.
|
AppendSwitchSecret |
Process |
Appends the specified secret text to the argument builder.
|
AppendSwitchSecret |
Process |
Appends the specified secret text to the argument builder.
|
CopyTo |
void |
Copies all the arguments of the source
ProcessArgumentBuilder to target ProcessArgumentBuilder .
|
Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
IsNullOrEmpty |
bool |
Indicates whether a
ProcessArgumentBuilder is null or renders empty.
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
Prepend |
Process |
Formats and prepends the specified text to the argument builder.
|
Prepend |
Process |
Prepend the specified text to the argument builder.
|
PrependQuoted |
Process |
Quotes and prepends the specified argument to the argument builder.
|
PrependQuoted |
Process |
Formats, quotes and prepends the specified text to the argument builder.
|
PrependQuoted |
Process |
Quotes and prepends the specified text to the argument builder.
|
PrependQuotedSecret |
Process |
Quotes and prepends the specified secret text to the argument builder.
|
PrependQuotedSecret |
Process |
Quotes and prepends the specified secret text to the argument builder.
|
PrependQuotedSecret |
Process |
Formats, quotes and prepends the specified secret text to the argument builder.
|
PrependQuotedSecret |
Process |
Quotes and prepend the specified secret text to the argument builder.
|
PrependQuotedSecret |
Process |
Quotes and prepends the specified secret text to the argument builder.
|
PrependSecret |
Process |
Prepend the specified secret text to the argument builder.
|
PrependSecret |
Process |
Formats and prepend the specified secret text to the argument builder.
|
PrependSecret |
Process |
Prepends the specified secret text to the argument builder.
|
PrependSwitch |
Process |
Prepend the specified switch to the argument builder.
|
PrependSwitch |
Process |
Prepend the specified switch to the argument builder.
|
PrependSwitchQuoted |
Process |
Quotes and prepends the specified argument to the argument builder.
|
PrependSwitchQuoted |
Process |
Quotes and prepends the specified argument to the argument builder.
|
PrependSwitchQuoted |
Process |
Quotes and prepends the specified text to the argument builder.
|
PrependSwitchQuoted |
Process |
Quotes and prepends the specified text to the argument builder.
|
Prepend |
Process |
Quotes and prepends the specified secret text to the argument builder.
|
Prepend |
Process |
Quotes and prepend the specified secret text to the argument builder.
|
PrependSwitchSecret |
Process |
Prepend the specified secret text to the argument builder.
|
PrependSwitchSecret |
Process |
Prepend the specified secret text to the argument builder.
|
PrependSwitchSecret |
Process |
Prepend the specified secret text to the argument builder.
|
PrependSwitchSecret |
Process |
Prepend the specified secret text to the argument builder.
|
ThrowIfNull |
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 |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
To |
string |
Returns the string value or a
Not set > markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|