Class BindingReport

Namespace

Valheim.Testing.Bindings

Assembly

Valheim.Testing.Bindings.dll

public sealed class BindingReport

Inheritance

object

BindingReport

Constructors

BindingReport(string, string, IReadOnlyList<BindingFinding>, IReadOnlyList<BindingFinding>, IReadOnlyList<ReferencedAssembly>, IReadOnlyList<ReferencedAssembly>, IReadOnlyList<string>, IReadOnlyList<string>, IReadOnlyList<string>)

public BindingReport(string modPath, string modAssembly, IReadOnlyList<BindingFinding> missing, IReadOnlyList<BindingFinding> access, IReadOnlyList<ReferencedAssembly> @checked, IReadOnlyList<ReferencedAssembly> notChecked, IReadOnlyList<string> missingRequired, IReadOnlyList<string> ignoresAccessChecksTo, IReadOnlyList<string> notes)

Parameters

modPath string

modAssembly string

missing IReadOnlyList<BindingFinding>

access IReadOnlyList<BindingFinding>

checked IReadOnlyList<ReferencedAssembly>

notChecked IReadOnlyList<ReferencedAssembly>

missingRequired IReadOnlyList<string>

ignoresAccessChecksTo IReadOnlyList<string>

notes IReadOnlyList<string>

Properties

Access

References that bind but are not accessible from the mod. Expected for a mod built against publicized assemblies.

public IReadOnlyList<BindingFinding> Access { get; }

Property Value

IReadOnlyList<BindingFinding>

Binds

No missing references in the checked assemblies. Says nothing about NotChecked assemblies.

public bool Binds { get; }

Property Value

bool

Checked

public IReadOnlyList<ReferencedAssembly> Checked { get; }

Property Value

IReadOnlyList<ReferencedAssembly>

IgnoresAccessChecksTo

Assemblies the mod names in IgnoresAccessChecksTo attributes.

public IReadOnlyList<string> IgnoresAccessChecksTo { get; }

Property Value

IReadOnlyList<string>

Missing

References that would not bind at run time.

public IReadOnlyList<BindingFinding> Missing { get; }

Property Value

IReadOnlyList<BindingFinding>

MissingRequired

Required assemblies (see RequiredAssemblies) the mod references that were not supplied: the check is incomplete.

public IReadOnlyList<string> MissingRequired { get; }

Property Value

IReadOnlyList<string>

ModAssembly

public string ModAssembly { get; }

Property Value

string

ModPath

public string ModPath { get; }

Property Value

string

NotChecked

public IReadOnlyList<ReferencedAssembly> NotChecked { get; }

Property Value

IReadOnlyList<ReferencedAssembly>

Notes

Parts of the mod that could not be read completely, such as attribute arguments naming an enum in an unavailable assembly.

public IReadOnlyList<string> Notes { get; }

Property Value

IReadOnlyList<string>

UndeclaredAccess

Access findings in assemblies the mod does not declare IgnoresAccessChecksTo for.

public IEnumerable<BindingFinding> UndeclaredAccess { get; }

Property Value

IEnumerable<BindingFinding>

Methods

WriteText(TextWriter, int)

Writes the report for a person or a CI log; at most maxUsers users are listed per finding.

public void WriteText(TextWriter output, int maxUsers = 10)

Parameters

output TextWriter

maxUsers int