OkfBundleLoadResult class final

The result of inspecting an OKF bundle directory.

bundle contains every entry that could be read successfully. Path, UTF-8, and document parse failures are retained in report, so one invocation can report every malformed file; validate merges them with the validator's findings into the complete Report.

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 OkfReport report})

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
hasFindings → bool
Whether any file failed to load, so bundle is partial.
no setter
hashCode → int
The hash code for this object.
no setterinherited
indexes → Map<String, String>
Reserved index.md files keyed 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
report → OkfReport
Load-time findings only — files that could not be read as part of the bundle — in canonical Report order.
final
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
validate() → OkfSpecValidation
Validates the loaded bundle and merges load findings into one Report.
validateCandidate(OkfBundle candidate, {Iterable<String> replacedPaths = const <String>[]}) → OkfSpecValidation
Validates a prospective complete candidate while retaining source load failures except those repaired by replacedPaths.

Operators

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