AnyMessageLogReader Class Reference

Space-ng SDK: sol3::core::AnyMessageLogReader Class Reference
Space-ng SDK
sol3::core::AnyMessageLogReader Class Reference

#include <sol3/core/any_message_log_reader.h>

Classes

class  Item
 
class  Iterator
 

Public Types

using ReadError = SizeDelimitedLogReader::ReadError
 

Public Member Functions

 AnyMessageLogReader (cpp::fs::path const &log_path)
 Construct a reader for a single log file path. More...
 
MessageSchema schemaForMessageLogHeader () const
 
MessageSchema schemaForMessageHeader () const
 
MessageSchema schemaForPayload () const
 
tl::expected< flatbuffers::span< uint8_t const >, ReadErrorlogHeaderSpan () const
 Size-prefixed message log header bytes. More...
 
Iterator begin () const
 Iterator over header/payload message pairs. More...
 
Iterator end () const
 

Detailed Description

Reads messages from log files without compile-time message definitions.

Layout and alignment details are documented in AnyMessageLogWriter. Iteration yields pairs of header/payload frames in order, skipping the schema entries and the message log header.

Member Typedef Documentation

◆ ReadError

Constructor & Destructor Documentation

◆ AnyMessageLogReader()

sol3::core::AnyMessageLogReader::AnyMessageLogReader ( cpp::fs::path const &  log_path)
explicit

Construct a reader for a single log file path.

Member Function Documentation

◆ begin()

Iterator sol3::core::AnyMessageLogReader::begin ( ) const

Iterator over header/payload message pairs.

◆ end()

Iterator sol3::core::AnyMessageLogReader::end ( ) const

◆ logHeaderSpan()

tl::expected<flatbuffers::span<uint8_t const>, ReadError> sol3::core::AnyMessageLogReader::logHeaderSpan ( ) const

Size-prefixed message log header bytes.

◆ schemaForMessageHeader()

MessageSchema sol3::core::AnyMessageLogReader::schemaForMessageHeader ( ) const

◆ schemaForMessageLogHeader()

MessageSchema sol3::core::AnyMessageLogReader::schemaForMessageLogHeader ( ) const

◆ schemaForPayload()

MessageSchema sol3::core::AnyMessageLogReader::schemaForPayload ( ) const

The documentation for this class was generated from the following file: