ark::awlog::AwlogReader

Defined in header “ark/awlog/awlog_reader.hh”.


This class is able to read in awlog files. It allows you to extract metadata about the underlying log, as well as iterate through the objects.

Methods

  • AwlogReader(const std::filesystem::path & path)
    Constructor. Initializes the log reader to read from the given path.

  • ~AwlogReader()
    Cleans up resources associated with this reader.

  • AwlogManifest manifest()
    Returns the manifest associated with this log.

  • std::optional< LoggedObject > step()
    Reads the next item in the awlog, returning an empty optional if there are no more entries remaining. Note that objects returned from this routine will go out of scope (and be unreadable safely) if you call step() again or let the AwlogReader fall out of scope.