Sid.Tools.StaticVisitor 2.1.0

.NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. 
dotnet add package Sid.Tools.StaticVisitor --version 2.1.0
                    


                    

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


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Sid.Tools.StaticVisitor" />
                    


                            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 Sid.Tools.StaticVisitor --version 2.1.0
                    


                    

                
#r "nuget: Sid.Tools.StaticVisitor, 2.1.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 Sid.Tools.StaticVisitor@2.1.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=Sid.Tools.StaticVisitor&version=2.1.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Sid.Tools.StaticVisitor&version=2.1.0
                    


                            Install as a Cake Tool

StaticVisitor (namespace: Sid.Tools.StaticVisitor)

A customizable data structure static visitor for C#.

This package, released under MIT license, allows to statically visit data structures easily in C#. Static visit means that it's the types (objects) of the data structure that get visited, not the instances.

Usages

The basic usage is to create an instance of Sid.Tools.StaticVisitor.StaticVisitor and pass an IList<Type> that will collect the results of the visit, then invoke the Visit method.

Overloads for more advanced behaviour also exist, where you specify a custom Action<Type> which defines what custom action to execute upon visit.

Please note that not all types are visited by default: by default primitive types and object are not visited; this behaviour can be customized (see below).

Visit behaviour can be customized by passing a custom StaticVisitorConfiguration instance.

Basic example

The method DoSomething

public class DataStructure {
   public Property SomeProperty { get; }
}

public class Property {}

public void DoSomething() {
   var visitor = new StaticVisitor(out var list);
   visitor.Visit(typeof(DataStructure));
}

will populate list with the types

  • DataStructure
  • Property

Custom type filtering example

The following code

var visitor = new Sid.Tools.StaticVisitor.StaticVisitor(out var list, new Tools.DataStructure.StaticVisitorConfiguration()
   {
      TypeCanBeVisited = x =>
         Sid.Tools.StaticVisitor.StaticVisitorConfiguration.DefaultTypeCanBeVisited(x)
         && !x.IsValueType
   });

will specify which types should be visited and which shouldn't. Specifically it will preserve the default behaviour, but also exclude types that are value types.

Advanced configuration

Please refer to the docstring documentation in https://github.com/micheledicosmo/StaticVisitor/blob/master/StaticVisitor/StaticVisitor.cs in the object StaticVisitorConfiguration.

Order of visit

The types get visited following this order:

  • The type itself
  • Inherited types
  • Encompassing types
  • Assignable types (disabled by default)
  • Properties
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.  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. 
.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.

  • .NETStandard 2.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.1.0 1,060 11/7/2019
1.5.0 961 10/24/2019
1.4.1 965 10/24/2019
1.4.0 945 10/24/2019
1.3.1 983 10/23/2019
1.3.0 966 10/23/2019
1.2.1 1,005 10/22/2019
1.2.0 979 10/22/2019
1.1.0 992 10/22/2019