Skip to content

Class SkippedDocument

Namespace: Apogee.Content.Assets
Assembly: Apogee.Content.dll

A file the search could not use, and why: the reason is written for a person (read-only, not valid UTF-8…).

public sealed record SkippedDocument : IEquatable<SkippedDocument>

Inheritance

object ← SkippedDocument

Implements

IEquatable<SkippedDocument>

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()

Constructors

SkippedDocument(string, string, bool)

A file the search could not use, and why: the reason is written for a person (read-only, not valid UTF-8…).

public SkippedDocument(string Document, string Reason, bool Blocking = false)

Parameters

Document string

The document, as the virtual path it was found at.

Reason string

Why it was not used.

Blocking bool

True when the document could be written: its references (if it has any) are then not rewritten and will break, so a rename that is applied is refused unless the caller allows it (allowSkipped). False for a document in a read-only root, which nothing could have rewritten.

Properties

Blocking

True when the document could be written: its references (if it has any) are then not rewritten and will break, so a rename that is applied is refused unless the caller allows it (allowSkipped). False for a document in a read-only root, which nothing could have rewritten.

public bool Blocking { get; init; }

Property Value

bool

Document

The document, as the virtual path it was found at.

public string Document { get; init; }

Property Value

string

Reason

Why it was not used.

public string Reason { get; init; }

Property Value

string