Dump(T) Method (IEnumerable(T), Func(T, String), ConsoleColor)

EnumerableDebugger Dump T Method (IEnumerable T , Func T, String , ConsoleColor)

CleanCode C# Libraries v1.2.03 API

Dumps the specified input to the console, decorating the input with a custom function and colorizing per the specified color.

Namespace: CleanCode.Diagnostics
Assembly: CleanCode (in CleanCode.dll) Version: 1.2.3.0 (1.2.03)

Syntax

C++

Copy to Clipboard Print

public static IEnumerable<T> Dump<T>(
	this IEnumerable<T> input,
	Func<T, string> toString,
	ConsoleColor textColor
)

public static IEnumerable<T> Dump<T>(
	this IEnumerable<T> input,
	Func<T, string> toString,
	ConsoleColor textColor
)

<ExtensionAttribute> _
Public Shared Function Dump(Of T) ( _
	input As IEnumerable(Of T), _
	toString As Func(Of T, String), _
	textColor As ConsoleColor _
) As IEnumerable(Of T)

<ExtensionAttribute> _
Public Shared Function Dump(Of T) ( _
	input As IEnumerable(Of T), _
	toString As Func(Of T, String), _
	textColor As ConsoleColor _
) As IEnumerable(Of T)

public:
[ExtensionAttribute]
generic<typename T>
static IEnumerable<T>^ Dump(
	IEnumerable<T>^ input, 
	Func<T, String^>^ toString, 
	ConsoleColor textColor
)

public:
[ExtensionAttribute]
generic<typename T>
static IEnumerable<T>^ Dump(
	IEnumerable<T>^ input, 
	Func<T, String^>^ toString, 
	ConsoleColor textColor
)

Parameters

input: Type: System.Collections.Generic IEnumerable T
The input.

toString: Type: System Func T, String
Anonymous method to convert input elements to strings.

textColor: Type: System ConsoleColor
Color of the text.

Type Parameters

T: The type of the elements of source.

Return Value

Input unchanged.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Online

IEnumerable T . When you use instance method syntax to call this method, omit the first parameter. For more information, see Online

Extension Methods (Visual Basic) or Online

Extension Methods (C# Programming Guide).

Examples

Assume you have a word list in a string array. This example processes the list with LINQ while dumping every step to the console. Each step is labeled using the anonymous method supplied to the call, and each is colorized distinctly.

Copy to Clipboard Print

return words
    .Dump(w => "ORIGINAL: " + w, ConsoleColor.Yellow)
    .Select(word => word.Trim())
    .Dump(w => "TRIMMED: " + w, ConsoleColor.Yellow)
    .Select(word => word.ToLower())
    .Dump(w => "LOWERCASE: " + w, ConsoleColor.Green)
    .Where(word => word.StartsWith("k"))
    .Dump(w => "FILTERED to 'K': " + w, ConsoleColor.Red)
    .OrderBy(word => word)
    .Dump(w => "SORTED: " + w, ConsoleColor.Blue);

return words
    .Dump(w => "ORIGINAL: " + w, ConsoleColor.Yellow)
    .Select(word => word.Trim())
    .Dump(w => "TRIMMED: " + w, ConsoleColor.Yellow)
    .Select(word => word.ToLower())
    .Dump(w => "LOWERCASE: " + w, ConsoleColor.Green)
    .Where(word => word.StartsWith("k"))
    .Dump(w => "FILTERED to 'K': " + w, ConsoleColor.Red)
    .OrderBy(word => word)
    .Dump(w => "SORTED: " + w, ConsoleColor.Blue);