OkfLogDocument class final

The parsed content of an OKF log.md document.

This type owns the log.md entry format: producers emit through serialize and consumers read through parse, so no other module needs to know how an entry is spelled.

Constructors

OkfLogDocument({required String title, required Iterable<OkfLogEntry> entries})

Creates a log document from entry data.

Properties

entries → List<OkfLogEntry>

The entries in document order.

final

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

title → String

The level-one document title, empty when the log declares none.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

serialize() → String

Emits the document.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

parse(String source, {String? sourcePath}) → OkfLogParseResult

Parses a complete log file.

parseBody(String body) → OkfLogParseResult

Parses a log body already separated from any frontmatter.