ObjectStructure 8.0.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package ObjectStructure --version 8.0.0
                    


                    

                
NuGet\Install-Package ObjectStructure -Version 8.0.0
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="ObjectStructure" Version="8.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="ObjectStructure" Version="8.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="ObjectStructure" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add ObjectStructure --version 8.0.0
                    


                    

                
#r "nuget: ObjectStructure, 8.0.0"
#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. 
#:package ObjectStructure@8.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=ObjectStructure&version=8.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=ObjectStructure&version=8.0.0
                    


                            Install as a Cake Tool

ObjectStructure

A libary that creates a flat structure for types and a flat key-value structure for instances.

Usage

If you just ant to create the schema of a type just pass it to the IStructureBuilder.

IStructureBuilder builder = new StructureBuilder();
Structure structure = builder.CreateStructure<Customer>();

Console.WriteLine(structure.Schema);

This will result in a flat list of the property structure of the type Customer.

FirstName
LastName
Address
Address.Street
Address.Number
Address.Zip
Address.City
Address.Country
Tags

To create the schema and accessors for the values of an instance pass the instance to the IStructureBuilder.

Customer customer = new Customer
{
	FirstName = "Sherlock",
	LastName = "Holmes",
	Address = new Address
	{
		Street = "Baker Street",
		Number = "221b",
		Zip = "NW1",
		City = "London",
		Country = "England"
	},
	Tags = new string[] { "detective", "addict" }
};

IStructureBuilder builder = new StructureBuilder();
Structure structure = builder.CreateStructure(customer);

Console.WriteLine(structure.Indices);

This will result in a flat list of the property values in the given instance of type Customer.

FirstName = "Sherlock"
LastName = "Holmes"
Address = "ConsoleApp1.Address"
Address.Street = "Baker Street"
Address.Number = "221b"
Address.Zip = "NW1"
Address.City = "London"
Address.Country = "England"
Tags = "System.String[]"
Tags[0] = "detective"
Tags[1] = "addict"

Acknowledgement

Most of the terminology and code structure of the library comes from the libary Structurizer by Daniel Wertheim. This is basically a fork of his work which I bent to my needs, f.e. the need to support null values in index values and some other fixes and tweaks. I completely remove the configuration part and added the ability to just get the schema of a type. The library this work is based on is licensed under the MIT license and so it this library.

References

Daniel Wertheim

Structurizer

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.