okf_io library
File-system support for Open Knowledge Format bundles.
Classes
- OkfAttester
- The deterministic check for an Attested Computation receipt.
- OkfBundle
- A platform-independent, in-memory OKF knowledge bundle.
- OkfBundleLoader
- Loads OKF bundles from an explicitly supplied filesystem root.
- OkfBundleLoadIssue
- A document that could not be decoded or parsed while loading a bundle.
- OkfBundleLoadResult
- The result of inspecting an OKF bundle directory.
- OkfBundleWriter
- Writes files beneath an explicit OKF bundle root.
- OkfComputationContract
- Typed view over an Attested Computation's top-level contract fields.
- OkfComputationParameter
- One declared, runtime-specific computation parameter.
- OkfConceptId
-
The bundle-relative path of an OKF concept, without the
.mdsuffix. - OkfDiagnostic
- A machine-readable problem found while consuming an OKF bundle.
- OkfDocument
- An Open Knowledge Format document: YAML frontmatter and a Markdown body.
- OkfExecutor
- Instructions for running an Attested Computation.
- OkfGeneration
- How the current content was generated.
- OkfGraph
- A deterministic graph derived from concept links and path-valued fields.
- OkfGraphEdge
- A directed relationship originating at an OKF concept.
- OkfGraphNode
- A concept node in an OkfGraph.
- OkfIndexEntry
- One item used to describe a generated directory index.
- OkfIndexGenerator
-
Generates deterministic, progressively disclosed
index.mdfiles. - OkfLegacyCitation
-
One entry from a legacy v0.1
# Citationssection. - OkfMetadata
- An order-preserving typed view over open OKF frontmatter.
- OkfSource
- A material from which an OKF concept was derived.
- OkfUsageWindow
- A date range framing one or more source usage counts.
- OkfValidationReport
- The complete result of validating an in-memory OKF bundle.
- OkfValidator
- Checks OKF v0.2 conformance and emits advisory shape diagnostics.
- OkfVerification
- An event that confirmed a concept against its source or resource.
- OkfWriteResult
- The outcome of writing or checking a set of bundle files.
- OkfYamlEmitter
-
A small deterministic YAML emitter for values returned by
package:yaml.
Enums
- OkfDiagnosticSeverity
- The severity of an OkfDiagnostic.
- OkfGraphEdgeOrigin
- Where a graph relationship was discovered.
- OkfGraphResolution
- How an edge target was classified.
- OkfLifecycleStatus
- The lifecycle state of an OKF concept.
- OkfTrustTier
- A trust tier derived from verification events.
Constants
-
okfKnownFrontmatterKeys
→ const Set<
String> - Frontmatter keys defined by OKF v0.2, including the v0.1 fallback key.
-
okfPreferredFrontmatterKeyOrder
→ const List<
String> - Preferred top-level frontmatter order used by OKF producer tooling.
Typedefs
-
OkfDirectoryDescriptionSynthesizer
= String Function(String directory, List<
OkfIndexEntry> entries) - Supplies a deterministic description for a directory index.
- OkfDocumentError = OkfDocumentException
- Backward-friendly short name for document parsing failures.
Exceptions / Errors
- OkfBundleLoadException
- Thrown by OkfBundleLoader.load when inspection finds malformed files.
- OkfDocumentException
- A failure to split or parse an OKF concept document.
- OkfYamlEncodeException
- A value could not be represented by the deterministic YAML emitter.