Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

YamlMergeReport

OfficeIMO.Yaml

Namespace
OfficeIMO.Yaml
Assembly
OfficeIMO.Yaml
Source revision
0eef6a5756b9 with working tree changes
Modifiers
sealed

What a merge changed in the base document, as paths in the grammar YamlNode.Select reads, plus the findings it recorded: kind conflicts, edits of nodes that aliases share, renamed anchors, expanded aliases and keys a null could not remove.

Inheritance

  • object
  • YamlMergeReport

Usage

Explore 2 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 2

Properties

public IReadOnlyList<string> Added { get; } #

Gets the paths of entries, items and documents the overlay added, in the order they were added.

public IReadOnlyList<string> Replaced { get; } #

Gets the paths whose value the overlay changed: scalars with a different value, values of another kind and sequences replaced with different items. Values the overlay restates unchanged are not listed.

public IReadOnlyList<string> Removed { get; } #

Gets the paths of keys an overlay null removed under YamlMergeOptions.NullRemovesKey.

public IReadOnlyList<OfficeDiagnostic> Diagnostics { get; } #

Gets the findings the merge recorded; they are also added to the base document's YamlDocument.Diagnostics.