FrameView Class Reference

Space-ng SDK: sol3::core::SizeDelimitedLogReader::FrameView Class Reference
Space-ng SDK
sol3::core::SizeDelimitedLogReader::FrameView Class Reference

#include <sol3/core/size_delimited_log_reader.h>

Public Member Functions

 FrameView ()
 
flatbuffers::span< uint8_t const > span () const
 
flatbuffers::span< uint8_t const > spanNoPrefix () const
 
size_t offsetBytes () const
 Byte offset of the frame within the file. More...
 

Friends

class SizeDelimitedLogReader
 
class Iterator
 

Detailed Description

Read-only view of a single size-prefixed frame in the log file.

FrameView references memory that stays valid while the FrameView exists.

Constructor & Destructor Documentation

◆ FrameView()

sol3::core::SizeDelimitedLogReader::FrameView::FrameView ( )

Member Function Documentation

◆ offsetBytes()

size_t sol3::core::SizeDelimitedLogReader::FrameView::offsetBytes ( ) const
inline

Byte offset of the frame within the file.

◆ span()

flatbuffers::span<uint8_t const> sol3::core::SizeDelimitedLogReader::FrameView::span ( ) const
inline

Span that includes the size prefix and payload bytes only.

Layout: | uint32_t payload_size | payload bytes |. span().size() == sizeof(uint32_t) + payload_size.

◆ spanNoPrefix()

flatbuffers::span<uint8_t const> sol3::core::SizeDelimitedLogReader::FrameView::spanNoPrefix ( ) const

Span of the payload bytes (size prefix removed). Throws ReadErrorException if the prefix is invalid or truncated.

Friends And Related Function Documentation

◆ Iterator

friend class Iterator
friend

◆ SizeDelimitedLogReader

friend class SizeDelimitedLogReader
friend

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