Nuke.Cola.Tooling.ArgumentStringHandlerEx Struct Reference

Public Member Functions
	ArgumentStringHandlerEx (int literalLength, int formattedCount, out bool handlerIsValid)
void	AppendLiteral (string value)
void	AppendFormatted (object? obj, int alignment=0, string? format=null)
string	ToStringAndClear ()
Func< string, string >	GetFilter ()

Static Public Member Functions
static string	Render (ArgumentStringHandlerEx input)
static implicit	operator ArgumentStringHandlerEx (string value)

Private Member Functions
string? string format	GetObjectString (object? obj, int alignment=0, string? format=null)
void	AppendFormatted (string? value, int alignment, string? format)
void	AppendFormatted (IAbsolutePathHolder? holder, int alignment, string? format)

Private Attributes
DefaultInterpolatedStringHandler	_builder
readonly List< string >	_secretValues
string	output

Detailed Description

An interpolated string handler used for comfortably set program arguments. It is an iteration over Nuke's own ArgumentStringHandler. This "Ex" version will not use double quotes automatically making its output more predictable than Nuke's handler. However, it supports explicit quoting with the :quote/q and :singleQuote/sq format specifiers.

ArgumentStringHandlerEx also has the following additional features

• Collapse multiline text into a single line joined with space
• Interpret ValueTuples with 2 items as optional parameters. If the second value is empty, the first value will not expand either. The "key" and "value" are concatenated together directly upon expansion. All format specifiers work and applied only to "value".

Definition at line 29 of file ArgumentStringHandlerEx.cs.

Constructor & Destructor Documentation

ArgumentStringHandlerEx()

Nuke.Cola.Tooling.ArgumentStringHandlerEx.ArgumentStringHandlerEx	(	int	literalLength,
		int	formattedCount,
		out bool	handlerIsValid )

Definition at line 39 of file ArgumentStringHandlerEx.cs.

Member Function Documentation

AppendFormatted() [1/3]

void Nuke.Cola.Tooling.ArgumentStringHandlerEx.AppendFormatted ( IAbsolutePathHolder? holder, int alignment, string? format )

private

Definition at line 120 of file ArgumentStringHandlerEx.cs.

AppendFormatted() [2/3]

void Nuke.Cola.Tooling.ArgumentStringHandlerEx.AppendFormatted	(	object?	obj,
		int	alignment = 0,
		string?	format = null )

Definition at line 59 of file ArgumentStringHandlerEx.cs.

AppendFormatted() [3/3]

void Nuke.Cola.Tooling.ArgumentStringHandlerEx.AppendFormatted ( string? value, int alignment, string? format )

private

Definition at line 115 of file ArgumentStringHandlerEx.cs.

AppendLiteral()

void Nuke.Cola.Tooling.ArgumentStringHandlerEx.AppendLiteral

(

string

value

)

Definition at line 54 of file ArgumentStringHandlerEx.cs.

GetFilter()

Func< string, string > Nuke.Cola.Tooling.ArgumentStringHandlerEx.GetFilter

(

)

Definition at line 134 of file ArgumentStringHandlerEx.cs.

GetObjectString()

string? string format Nuke.Cola.Tooling.ArgumentStringHandlerEx.GetObjectString ( object? obj, int alignment = 0, string? format = null )

private

Definition at line 78 of file ArgumentStringHandlerEx.cs.

operator ArgumentStringHandlerEx()

static implicit Nuke.Cola.Tooling.ArgumentStringHandlerEx.operator ArgumentStringHandlerEx ( string value )

static

Definition at line 49 of file ArgumentStringHandlerEx.cs.

Render()

static string Nuke.Cola.Tooling.ArgumentStringHandlerEx.Render ( ArgumentStringHandlerEx input )

static

Definition at line 34 of file ArgumentStringHandlerEx.cs.

ToStringAndClear()

string Nuke.Cola.Tooling.ArgumentStringHandlerEx.ToStringAndClear

(

)

Definition at line 125 of file ArgumentStringHandlerEx.cs.

Member Data Documentation

_builder

DefaultInterpolatedStringHandler Nuke.Cola.Tooling.ArgumentStringHandlerEx._builder

private

Definition at line 31 of file ArgumentStringHandlerEx.cs.

_secretValues

readonly List<string> Nuke.Cola.Tooling.ArgumentStringHandlerEx._secretValues

private

Definition at line 32 of file ArgumentStringHandlerEx.cs.

output

string Nuke.Cola.Tooling.ArgumentStringHandlerEx.output

private

Definition at line 78 of file ArgumentStringHandlerEx.cs.

---

The documentation for this struct was generated from the following file:

• /home/runner/work/md.Nuke.Cola/md.Nuke.Cola/md.Nuke.Cola/Tooling/ArgumentStringHandlerEx.cs