sol3::core::SizeDelimitedLogReader::Iterator Class Reference

#include <sol3/core/size_delimited_log_reader.h>

Public Types
using	value_type = FrameView
using	reference = FrameView const &
using	pointer = FrameView const *

Public Member Functions
	Iterator ()
	Iterator (tl::expected< FrameView, ReadError > current)
	Iterator (Iterator const &)=default
Iterator &	operator= (Iterator const &other)=default
	Iterator (Iterator &&)=default
Iterator &	operator= (Iterator &&other)=default
	~Iterator ()=default
reference	operator* () const
	Access the current frame; throws ReadErrorException if in error state. More...
pointer	operator-> () const
	Access the current frame; throws ReadErrorException if in error state. More...
Iterator &	operator++ ()
bool	operator== (Iterator const &other) const
bool	operator!= (Iterator const &other) const
tl::expected< FrameView, ReadError > const &	frameView () const
	Access the current frame or the read error, if any. More...

Detailed Description

Input iterator over frames returned by the reader.

Dereferencing yields a FrameView and throws on read errors. Only EOF compares equal to end().

Member Typedef Documentation

pointer

using sol3::core::SizeDelimitedLogReader::Iterator::pointer = FrameView const*

reference

using sol3::core::SizeDelimitedLogReader::Iterator::reference = FrameView const&

value_type

using sol3::core::SizeDelimitedLogReader::Iterator::value_type = FrameView

Constructor & Destructor Documentation

Iterator() [1/4]

sol3::core::SizeDelimitedLogReader::Iterator::Iterator

(

)

Iterator() [2/4]

sol3::core::SizeDelimitedLogReader::Iterator::Iterator ( tl::expected< FrameView, ReadError >  current )

explicit

Iterator() [3/4]

sol3::core::SizeDelimitedLogReader::Iterator::Iterator ( Iterator const &  )

default

Iterator() [4/4]

sol3::core::SizeDelimitedLogReader::Iterator::Iterator ( Iterator &&  )

default

~Iterator()

sol3::core::SizeDelimitedLogReader::Iterator::~Iterator ( )

default

Member Function Documentation

frameView()

tl::expected<FrameView, ReadError> const& sol3::core::SizeDelimitedLogReader::Iterator::frameView

(

)

const

Access the current frame or the read error, if any.

operator!=()

bool sol3::core::SizeDelimitedLogReader::Iterator::operator!=

(

Iterator const &

other

)

const

operator*()

reference sol3::core::SizeDelimitedLogReader::Iterator::operator*

(

)

const

Access the current frame; throws ReadErrorException if in error state.

operator++()

Iterator& sol3::core::SizeDelimitedLogReader::Iterator::operator++

(

)

Advances to the next frame; throws ReadErrorException if already in error/end state.

operator->()

pointer sol3::core::SizeDelimitedLogReader::Iterator::operator->

(

)

const

Access the current frame; throws ReadErrorException if in error state.

operator=() [1/2]

Iterator& sol3::core::SizeDelimitedLogReader::Iterator::operator= ( Iterator &&  other )

default

operator=() [2/2]

Iterator& sol3::core::SizeDelimitedLogReader::Iterator::operator= ( Iterator const &  other )

default

operator==()

bool sol3::core::SizeDelimitedLogReader::Iterator::operator==

(

Iterator const &

other

)

const

---

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

• /workspaces/astro/sol3-sdk/cpp/sol3/core/size_delimited_log_reader.h