nuri::MoleculeStream< Reader > Class Template Reference

#include <nuri/fmt/base.h>

Public Member Functions
	MoleculeStream (Reader &reader)
	MoleculeStream (const MoleculeStream &)=delete
MoleculeStream &	operator= (const MoleculeStream &)=delete
	MoleculeStream (MoleculeStream &&) noexcept=default
MoleculeStream &	operator= (MoleculeStream &&) noexcept=default
	~MoleculeStream () noexcept=default
ABSL_MUST_USE_RESULT bool	advance ()
	Advance the stream to the next molecule.
Molecule &	current ()
	Get the current molecule.
const Molecule &	current () const
	Get the current molecule.

Constructor & Destructor Documentation

MoleculeStream() [1/3]

template<class Reader = MoleculeReader>

nuri::MoleculeStream< Reader >::MoleculeStream ( Reader & reader )

inline

MoleculeStream() [2/3]

template<class Reader = MoleculeReader>

nuri::MoleculeStream< Reader >::MoleculeStream ( const MoleculeStream< Reader > & )

delete

MoleculeStream() [3/3]

template<class Reader = MoleculeReader>

nuri::MoleculeStream< Reader >::MoleculeStream ( MoleculeStream< Reader > && )

defaultnoexcept

~MoleculeStream()

template<class Reader = MoleculeReader>

nuri::MoleculeStream< Reader >::~MoleculeStream ( )

defaultnoexcept

Member Function Documentation

advance()

template<class Reader = MoleculeReader>

ABSL_MUST_USE_RESULT bool nuri::MoleculeStream< Reader >::advance ( )

inline

Advance the stream to the next molecule.

Returns

true if the stream is not at the end, false otherwise.

Note

If this function returns false, the current molecule is not changed.

current() [1/2]

template<class Reader = MoleculeReader>

Molecule & nuri::MoleculeStream< Reader >::current ( )

inline

Get the current molecule.

Returns

Reference to the current molecule.

Precondition

Previous call to advance() must return true, otherwise the behavior is unspecified.

current() [2/2]

template<class Reader = MoleculeReader>

const Molecule & nuri::MoleculeStream< Reader >::current ( ) const

inline

Get the current molecule.

Returns

Const reference to the current molecule.

Precondition

Previous call to advance() must return true, otherwise the behavior is unspecified.

operator=() [1/2]

template<class Reader = MoleculeReader>

MoleculeStream & nuri::MoleculeStream< Reader >::operator= ( const MoleculeStream< Reader > & )

delete

operator=() [2/2]

template<class Reader = MoleculeReader>

MoleculeStream & nuri::MoleculeStream< Reader >::operator= ( MoleculeStream< Reader > && )

defaultnoexcept

---

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

• include/nuri/fmt/base.h