OkfBundleLoadResult class final

The result of inspecting an OKF bundle directory.

bundle contains every entry that could be read successfully. Parse and UTF-8 failures are retained in issues, allowing validators to report all malformed files in one invocation.

Constructors

OkfBundleLoadResult({required String rootPath, required OkfBundle bundle, required Map<String, OkfDocument> documents, required Map<String, String> indexes, required Map<String, String> logs, required Iterable<String> assets, required Iterable<OkfBundleLoadIssue> issues})

Properties

assets → List<String>
Non-Markdown files found under the bundle root.
final
bundle → OkfBundle
The successfully loaded portion of the bundle.
final
documents → Map<String, OkfDocument>
Concept documents keyed by sorted POSIX-style relative path.
final
hashCode → int
The hash code for this object.
no setterinherited
hasIssues → bool
Whether any files failed to load.
no setter
indexes → Map<String, String>
Reserved index.md files keyed by relative path.
final
issues → List<OkfBundleLoadIssue>
Decode and document parse failures, ordered by relative path.
final
logs → Map<String, String>
Reserved log.md files keyed by relative path.
final
paths → List<String>
Every regular file path in the inventory, in deterministic order.
no setter
rootPath → String
The normalized, absolute bundle root.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited