Class LocalItemLocation

Namespace

EncDotNet.S100.Collections

Assembly

EncDotNet.S100.Collections.dll

The item's data is on the local file system, either in a folder or inside a ZIP archive.

public sealed record LocalItemLocation : ItemLocation, IEquatable<ItemLocation>, IEquatable<LocalItemLocation>

Inheritance

object

ItemLocation

LocalItemLocation

Implements

IEquatable<ItemLocation>

IEquatable<LocalItemLocation>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Relative paths use forward slashes regardless of platform, so a persisted index is portable; hosts convert them when opening files.

Constructors

LocalItemLocation(string, string, IReadOnlyList<string>, string?, bool)

The item's data is on the local file system, either in a folder or inside a ZIP archive.

public LocalItemLocation(string RootPath, string RelativePath, IReadOnlyList<string> UpdateRelativePaths, string? CatalogueRelativePath = null, bool IsZip = false)

Parameters

RootPath string

The absolute path of the folder or ZIP that relative paths resolve against (the root of an asset source).

RelativePath string

The base dataset file, relative to RootPath.

UpdateRelativePaths IReadOnlyList<string>

Sequential update files in application order, relative to RootPath.

CatalogueRelativePath string

The exchange-set catalogue the item was read from, relative to RootPath, or null for a loose dataset.

IsZip bool

True when RootPath is a ZIP archive.

Remarks

Relative paths use forward slashes regardless of platform, so a persisted index is portable; hosts convert them when opening files.

Properties

CatalogueRelativePath

The exchange-set catalogue the item was read from, relative to RootPath, or null for a loose dataset.

public string? CatalogueRelativePath { get; init; }

Property Value

string

IsZip

True when RootPath is a ZIP archive.

public bool IsZip { get; init; }

Property Value

bool

RelativePath

The base dataset file, relative to RootPath.

public string RelativePath { get; init; }

Property Value

string

RootPath

The absolute path of the folder or ZIP that relative paths resolve against (the root of an asset source).

public string RootPath { get; init; }

Property Value

string

UpdateRelativePaths

Sequential update files in application order, relative to RootPath.

public IReadOnlyList<string> UpdateRelativePaths { get; init; }

Property Value

IReadOnlyList<string>