fcb::FeatureIterator Class Reference

Single-pass iterator over features. Not copyable. More...

#include <fcb/reader.hpp>

Public Member Functions
	FeatureIterator (std::shared_ptr< RangeReader > reader, HeaderView header, IterationMode mode, std::vector< SearchResultItem > hits)
	FeatureIterator (const FeatureIterator &)=delete
FeatureIterator &	operator= (const FeatureIterator &)=delete
	FeatureIterator (FeatureIterator &&)=default
FeatureIterator &	operator= (FeatureIterator &&)=delete
bool	next ()
	Advance.
const Feature &	current () const
std::uint64_t	features_count () const
	Total features the header claims, for progress reporting.

Detailed Description

Single-pass iterator over features. Not copyable.

Definition at line 35 of file reader.hpp.

Constructor & Destructor Documentation

FeatureIterator() [1/3]

fcb::FeatureIterator::FeatureIterator	(	std::shared_ptr< RangeReader >	reader,
		HeaderView	header,
		IterationMode	mode,
		std::vector< SearchResultItem >	hits
	)

Definition at line 120 of file reader.cpp.

References fcb::FileLayout::feature_begin, and fcb::HeaderView::layout().

FeatureIterator() [2/3]

fcb::FeatureIterator::FeatureIterator ( const FeatureIterator &  )

delete

FeatureIterator() [3/3]

fcb::FeatureIterator::FeatureIterator ( FeatureIterator &&  )

default

Member Function Documentation

current()

const Feature & fcb::FeatureIterator::current ( ) const

inline

Definition at line 49 of file reader.hpp.

Referenced by fcb::FcbReader::select_attr().

features_count()

std::uint64_t fcb::FeatureIterator::features_count ( ) const

inline

Total features the header claims, for progress reporting.

Definition at line 52 of file reader.hpp.

References fcb::FileInfo::features_count, and fcb::HeaderView::info().

Referenced by next().

next()

bool fcb::FeatureIterator::next

(

)

Advance.

Returns false once iteration is complete. Throws if the file is truncated before features_count features.

Definition at line 126 of file reader.cpp.

References fcb::detail::checked_add(), fcb::FileLayout::feature_begin, fcb::FileInfo::features_count, features_count(), fcb::HeaderView::info(), fcb::InvalidFlatbuffer, fcb::IoError, fcb::kBodyAlignPad, fcb::kMaxFeatureSize, fcb::HeaderView::layout(), fcb::detail::require_within(), and fcb::SequentialScan.

Referenced by fcb::FcbReader::select_attr().

operator=() [1/2]

FeatureIterator & fcb::FeatureIterator::operator= ( const FeatureIterator &  )

delete

operator=() [2/2]

FeatureIterator & fcb::FeatureIterator::operator= ( FeatureIterator &&  )

delete

---

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

• include/fcb/reader.hpp
• src/reader.cpp