ObjectDumper.NET 3.3.22-pre

This is a prerelease version of ObjectDumper.NET.
There is a newer version of this package available.
See the version list below for details.
dotnet add package ObjectDumper.NET --version 3.3.22-pre
NuGet\Install-Package ObjectDumper.NET -Version 3.3.22-pre
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="ObjectDumper.NET" Version="3.3.22-pre" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ObjectDumper.NET --version 3.3.22-pre
#r "nuget: ObjectDumper.NET, 3.3.22-pre"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install ObjectDumper.NET as a Cake Addin
#addin nuget:?package=ObjectDumper.NET&version=3.3.22-pre&prerelease

// Install ObjectDumper.NET as a Cake Tool
#tool nuget:?package=ObjectDumper.NET&version=3.3.22-pre&prerelease

ObjectDumper.NET

Version Downloads

ObjectDumper is a utility which aims to serialize C# objects to string for debugging and logging purposes.

Download and Install ObjectDumper.NET

This library is available on NuGet: https://www.nuget.org/packages/ObjectDumper.NET/ Use the following command to install ObjectDumper using NuGet package manager console:

PM> Install-Package ObjectDumper.NET

You can use this library in any .Net project which is compatible to PCL (e.g. Xamarin Android, iOS, Windows Phone, Windows Store, Universal Apps, etc.)

The Purpose of ObjectDumper

Serialization, the process of converting a complex object to a machine-readable or over-the-wire transmittable string, is a technique often used in software engineering. A well-known serializer is Newtonsoft.JSON which serializes .NET objects to the data representation format JSON.

ObjectDumper.NET provides two excellent ways to visualize in-memory .NET objects:

  • DumpStyle.Console: serialize objects to human-readable strings, often used to write complex C# objects to log files.
  • DumpStyle.CSharp: serialize objects to C# initializer code, which can be used to compile a C# object again.

API Usage

Dumping C# Objects to Console.WriteLine

The following sample program uses DumpStyle.Console to write C# objects to the console output:

static void Main(string[] args)
{
    var persons = new List<Person>
    {
        new Person { Name = "John", Age = 20, },
        new Person { Name = "Thomas", Age = 30, },
    };

    var personsDump = ObjectDumper.Dump(persons);

    Console.WriteLine(personsDump);
    Console.ReadLine();
}

//CONSOLE OUTPUT:
{ObjectDumperSample.Netfx.Person}
  Name: "John"
  Age: 20
{ObjectDumperSample.Netfx.Person}
  Name: "Thomas"
  Age: 30
Dumping C# initializer code from in-memory objects to Console.WriteLine

The following sample program uses DumpStyle.CSharp to write C# initializer code from in-memory to the console output:

static void Main(string[] args)
{
    var persons = new List<Person>
    {
        new Person { Name = "John", Age = 20, },
        new Person { Name = "Thomas", Age = 30, },
    };

    var personsDump = ObjectDumper.Dump(persons, DumpStyle.CSharp);

    Console.WriteLine(personsDump);
    Console.ReadLine();
}

//CONSOLE OUTPUT:
var listOfPersons = new List<Person>
{
  new Person
  {
    Name = "John",
    Age = 20
  },
  new Person
  {
    Name = "Thomas",
    Age = 30
  }
};

C# Escape / Unescape https://codebeautify.org/csharp-escape-unescape

License

This project is Copyright © 2022 Thomas Galliker. Free for non-commercial use. For commercial use please contact the author.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp1.0 was computed.  netcoreapp1.1 was computed.  netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard1.2 is compatible.  netstandard1.3 was computed.  netstandard1.4 was computed.  netstandard1.5 was computed.  netstandard1.6 was computed.  netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net45 is compatible.  net451 was computed.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen30 was computed.  tizen40 was computed.  tizen60 was computed. 
Universal Windows Platform uap was computed.  uap10.0 was computed. 
Windows Phone wpa81 was computed. 
Windows Store netcore451 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETFramework 4.5

    • No dependencies.
  • .NETStandard 1.2

  • .NETStandard 2.0

    • No dependencies.
  • .NETStandard 2.1

    • No dependencies.

NuGet packages (8)

Showing the top 5 NuGet packages that depend on ObjectDumper.NET:

Package Downloads
MercadoPagoCore

The inofficial MercadoPagoCore SDK for .NetCoreApps

CraxShared

Package Description

klefki

An ASP.NET core client for the Klefki API

SunamoReflection

Advanced reflection for faster development

KarambaCommon

An interactive, parametric Finite Element program for beams and shells.

GitHub repositories (4)

Showing the top 4 popular GitHub repositories that depend on ObjectDumper.NET:

Repository Stars
CodeMazeBlog/CodeMazeGuides
The main repository for all the Code Maze guides
ahmedayman4a/Linkedin-Learning-Courses-Downloader
Download LinkedIn Learning Courses in mp4 format and in the video quality you like with an intuitive UI
winsecurity/Offensive-C-Sharp
Sanae6/SmoOnlineServer
Official server for Super Mario Odyssey: Online
Version Downloads Last updated
4.1.17 886 3/26/2024
4.1.16-pre 234 3/11/2024
4.1.15 16,324 1/24/2024
4.1.13-pre 2,763 10/29/2023
4.1.12-pre 720 10/29/2023
4.1.11-pre 707 10/29/2023
4.1.6-pre 678 10/29/2023
4.1.4-pre 749 10/19/2023
4.1.3 90,950 6/20/2023
4.1.2-pre 1,005 6/20/2023
4.1.1-pre 1,042 6/17/2023
4.0.6 31,082 3/19/2023
4.0.5-pre 1,065 3/16/2023
4.0.4-pre 1,209 2/24/2023
4.0.3-pre 1,098 2/24/2023
3.5.6 40,367 1/31/2023
3.5.5-pre 1,118 12/31/2022
3.5.3-pre 1,250 10/15/2022
3.5.2 85,843 9/23/2022
3.5.1-pre 1,162 7/30/2022
3.4.6 135,977 6/24/2022
3.4.5-pre 1,075 6/2/2022
3.4.1-pre 1,010 6/2/2022
3.3.25-pre 1,090 6/1/2022
3.3.23-pre 1,076 5/31/2022
3.3.22-pre 1,145 5/7/2022
3.3.20 30,309 4/27/2022
3.3.19-pre 1,075 4/17/2022
3.3.18-pre 1,093 4/17/2022
3.3.16-pre 3,126 1/9/2022
3.3.15-pre 2,874 11/11/2021
3.3.13 125,192 10/7/2021
3.3.12-pre 1,315 10/2/2021
3.3.11-pre 1,271 10/2/2021
3.3.10-pre 1,399 8/30/2021
3.3.7 30,687 8/29/2021
3.3.6-pre 1,156 8/29/2021
3.3.5-pre 1,168 8/29/2021
3.3.4-pre 1,166 8/29/2021
3.3.3-pre 1,138 8/29/2021
3.3.2-pre 1,179 8/29/2021
3.2.1-pre 1,193 8/25/2021
3.1.21178.1 51,611 6/27/2021
3.1.21144.2-pre 1,792 5/24/2021
3.1.21143.2-pre 1,156 5/23/2021
3.1.21142.1-pre 1,302 5/22/2021
3.0.20251.2-pre 3,498 9/7/2020
3.0.20251.1 166,918 9/7/2020
3.0.20243.2-pre 1,377 8/30/2020
3.0.20243.1-pre 1,337 8/30/2020
3.0.20235.2-pre 1,444 8/22/2020
3.0.20235.1-pre 1,390 8/22/2020
3.0.20232.1-pre 1,348 8/19/2020
3.0.20229.11-pre 1,370 8/16/2020
3.0.20229.6-pre 1,302 8/16/2020
3.0.20229.3-pre 1,393 8/16/2020
3.0.20228.2-pre 1,408 8/15/2020
3.0.20228.1-pre 1,479 8/15/2020
2.5.20228.1 11,754 8/15/2020
2.5.20158.1-pre 2,120 6/6/2020
2.5.20155.1 81,625 6/3/2020
2.5.20143.3-pre 1,400 5/22/2020
2.5.20131.1-pre 1,430 5/10/2020
2.5.20033.1 43,045 2/2/2020
2.5.20023.4-pre 1,377 1/23/2020
2.5.20023.3-pre 1,316 1/23/2020
2.5.20023.1-pre 1,299 1/23/2020
2.4.20008.4-pre 1,417 1/8/2020
2.4.20008.1 4,935 1/8/2020
2.4.20007.2-pre 1,410 1/7/2020
2.4.19323.7-pre 2,075 11/19/2019
2.4.19323.6-pre 1,343 11/19/2019
2.4.19323.4-pre 1,351 11/19/2019
2.4.19292.2-pre 1,511 10/19/2019
2.4.19292.1-pre 1,289 10/19/2019
2.4.19286.1-pre 1,368 10/13/2019
2.4.19218.1 33,787 8/6/2019
2.4.19204.1-pre 1,459 7/23/2019
2.4.19166.1 7,674 6/15/2019
2.4.19138.1 66,370 5/18/2019
2.4.19119.1-pre 1,653 4/29/2019
2.3.19050.6 72,488 2/19/2019
2.3.19050.4-pre 1,509 2/19/2019
2.3.19050.3-pre 1,500 2/19/2019
2.3.19049.4-pre 1,559 2/18/2019
2.3.19046.3 5,580 2/15/2019
2.3.19046.1-pre 1,546 2/15/2019
2.2.19044.3-pre 1,457 2/13/2019
2.2.19021.1 2,764 1/21/2019
2.2.19011.1 2,474 1/11/2019
2.2.19007.1 1,849 1/7/2019
2.1.18332.7 2,804 11/29/2018
2.0.18317.1 2,786 11/13/2018
2.0.18311.1 1,843 11/7/2018
2.0.18282.1 4,732 10/9/2018
1.0.7 25,696 8/27/2018
1.0.6 2,142 8/3/2018
1.0.4 1,884 7/22/2018
1.0.3 2,886 7/2/2018
1.0.2 3,043 2/21/2018
1.0.1 3,646 6/19/2017
1.0.0 2,063 6/9/2017

3.3.0
- Bug fix for generic default value creation

3.2.0
- New versioning schema

3.1.0
- Add support for dumping anonymous types
- Add support for .NET 5
- Detect circular references for hash combinations h(value, type)
- Dump warning for circular references
- Performance improvement for property dumps

3.0.0
- New formatting logic for DumpStyle.Console (default)
- Bug fix for dumping decimal numbers in different cultures
- Dump MinValue, MaxValue for built-in types (where available)

2.5.0
- Handle CultureInfo formatting
- Extend GetFormattedName to handle nested generics and multi-dimensional arrays
- Optimize variable naming for generic types

2.4.0
- Handle Guid formatting
- Handle DateTimeOffset formatting
- Handle TimeSpan formatting
- Set LineBreakChar default to Environment.NewLine

2.3.0
- Fix escape sequences in string values

2.2.0
- Add bool property DumpOptions.IgnoreDefaultValues to filter properties which contain default values
- Refactor namespaces: Move ObjectDumper to root namespace
- Add support for netstandard2.0
     
2.0.0
- Migrate to netstandard1.2
- Bug fixes

1.0.8
- Bugfix for .Net Standard: CSharp initializer code generation for KeyValuePairs is currently disabled in this release

1.0.7
- Change DateTime formatting to ISO 8601 standard
- Add formatting for IDictionary&lt;TKey, TValue&gt; and KeyValuePair&lt;TKey, TValue&gt;

1.0.6
- Replace long suffix 'l' with 'L'

1.0.5
- Optimization for DateTime.MinValue and DateTime.MaxValue serialization

1.0.4
- Bug fix: Use default dump options if not specified

1.0.3
- Add support for .Net Standard
- Add DumpOptions several serialization options, e.g. C#-like DumpStyle

1.0.2
- Bug fix: Filter COM objects
- Bug fix: Catch exceptions if properties/fields cannot be accessed

1.0.1
- Bug fix: Ignore non-public properties
     
1.0.0
- Initial release