ObjectTreeWalker 0.8.0

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package ObjectTreeWalker --version 0.8.0                

                    
                

            
NuGet\Install-Package ObjectTreeWalker -Version 0.8.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="ObjectTreeWalker" Version="0.8.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add ObjectTreeWalker --version 0.8.0                

                    
                

            
#r "nuget: ObjectTreeWalker, 0.8.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. 
// Install ObjectTreeWalker as a Cake Addin
#addin nuget:?package=ObjectTreeWalker&version=0.8.0

// Install ObjectTreeWalker as a Cake Tool
#tool nuget:?package=ObjectTreeWalker&version=0.8.0

Build & Test

The What

ObjectGraphWalker is a simple utility library that allows traversing over C# object properties, Node.js style. Under the hood, the class generates accessors that would speed up the traversal.

The How

Simply instantiate the class and use the ObjectMemberIterator::Traverse() method.

var someObject = new SomeObject();
var iterator = new ObjectMemberIterator();
iterator.Traverse(someObject, (in MemberAccessor accessor) =>
{
    var propertyValue = accessor.GetValue();
    prop.SetValue(/* some other value */);
});

Note 1: it is also possible to use predicate parameter in the ObjectMemberIterator::Traverse() method to exclude some members from the iteration. The following example iterates over all fields and properties if their name is not Foo1

var someObject = new SomeObject();
var iterator = new ObjectMemberIterator();
iterator.Traverse(someObject, (in MemberAccessor accessor) =>
{
    var propertyValue = accessor.GetValue();
    prop.SetValue(/* some other value */);
}, (in MemberAccessor accessor) => accessor.Name != "Foo1");

Note 2: it is possible to filter for member types (iterate only on properties or fields), like shown in the following code

iterator.Traverse(someObject, (in MemberAccessor accessor) =>
{
    // do some operations or mutate data
}, (in MemberAccessor accessor) => accessor.MemberType != MemberType.Property);

Notes

  • The iterator will read public and private properties and fields but will ignore any static members of the object.
  • The iterator will work on both value and reference types
  • The iterator will ignore backing fields for "auto properties" and it will ignore any compiler generated fields such as closures (unless specified in the constructor)
  • The iterator is fairly well tested by there may be some bugs. If you do see something weird, I'd appreciate an opened issue with a description 😃
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  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 netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework 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 tizen40 was computed.  tizen60 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.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on ObjectTreeWalker:

Package Downloads
RoguelikeToolkit.Entities

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.11.1 201 4/25/2024
0.11.0 107 4/25/2024
0.10.18 528 8/21/2023
0.10.14 154 7/6/2023
0.10.13 149 5/27/2023
0.10.11 190 4/4/2023
0.10.8 405 1/14/2023
0.10.7 273 1/14/2023
0.10.5 284 12/25/2022
0.10.4 288 12/24/2022
0.10.3 1,973 12/3/2022
0.10.2 308 12/3/2022
0.9.4 312 11/29/2022
0.9.3 290 11/29/2022
0.9.2 481 11/7/2022
0.9.1 425 10/20/2022
0.9.0 413 10/19/2022
0.8.3 392 10/19/2022
0.8.2 453 9/26/2022
0.8.1 421 9/26/2022
0.8.0 394 9/26/2022
0.7.1 414 9/24/2022
0.7.0 548 9/24/2022
0.6.0 436 9/24/2022
0.5.3 412 9/24/2022
0.5.2 400 9/24/2022
0.4.1 462 9/17/2022
0.3.3 441 9/17/2022
0.3.1 445 9/17/2022

Changes since version v0.2.1.0

:sparkles: New Features:
- [`0f6e7dd`](https://github.com/myarichuk/ObjectTreeWalker/commit/0f6e7dd1f735231cfab83b16a57e64770e238747) - inner implementation - object enumerator to compute and cache property/field graph per type *(commit by [@myarichuk](https://github.com/myarichuk))*
- [`219854d`](https://github.com/myarichuk/ObjectTreeWalker/commit/219854d6524da067f975171381b22fe9d690826f) - implement basic object member iterator functionality, probably will need more testing *(commit by [@myarichuk](https://github.com/myarichuk))*

:bug: Bug Fixes:
- [`48f9c6c`](https://github.com/myarichuk/ObjectTreeWalker/commit/48f9c6c7a91d9ac02b619a37125ddfbe15f5ca66) - ensure returning false when getter/setter is missing from property and trying to get/set value *(commit by [@myarichuk](https://github.com/myarichuk))*
- [`ced48d3`](https://github.com/myarichuk/ObjectTreeWalker/commit/ced48d3263d135598068039a179dfa65ed200096) - add object graph cache to ObjectEnumerator *(commit by [@myarichuk](https://github.com/myarichuk))*
- [`ee10271`](https://github.com/myarichuk/ObjectTreeWalker/commit/ee102713bc5624c1ce0c5d327c36be8599c81a88) - ensure backing properties will not get iterated on and also no trying to "parse" children of primitive fields/properties *(commit by [@myarichuk](https://github.com/myarichuk))*

:white_check_mark: Tests:
- [`5db4961`](https://github.com/myarichuk/ObjectTreeWalker/commit/5db4961700afbacbf51a6c77b50b866059408293) - basic tests for ObjectMemberIterator *(commit by [@myarichuk](https://github.com/myarichuk))*

:wrench: Chores:
- [`b5a918c`](https://github.com/myarichuk/ObjectTreeWalker/commit/b5a918c05681ec587fce8d86f089ee6eb4d856f4) - ensure perf test won't be packaged with "dotnet pack" *(commit by [@myarichuk](https://github.com/myarichuk))*