altintegration::adaptors::BlockIteratorImpl< BlockT > Struct Template Reference

Detailed Description

template<typename BlockT>
struct altintegration::adaptors::BlockIteratorImpl< BlockT >

Definition at line 88 of file block_provider_impl.hpp.

Inheritance diagram for altintegration::adaptors::BlockIteratorImpl< BlockT >:

Collaboration diagram for altintegration::adaptors::BlockIteratorImpl< BlockT >:

Public Member Functions
	BlockIteratorImpl (std::shared_ptr< StorageIterator > it, const AltChainParams &params)
void	next () override
	Iterate to the next block. More...
bool	value (StoredBlockIndex< BlockT > &out) const override
	Return the current block value. More...
bool	key (typename BlockT::hash_t &out) const override
	Return the current block hash key. More...
bool	valid () const override
	Return if valid iterator or not. More...
void	seek_start () override
	Set iterator to the start of the collection. More...
virtual void	next ()=0
	Iterate to the next block. More...
virtual bool	value (StoredBlockIndex< BlockT > &out) const =0
	Return the current block value. More...
virtual bool	key (prev_hash_t &out) const =0
	Return the current block hash key. More...
virtual bool	valid () const =0
	Return if valid iterator or not. More...
virtual void	seek_start ()=0
	Set iterator to the start of the collection. More...

Additional Inherited Members
Public Types inherited from altintegration::BlockIterator< BlockT >
using	prev_hash_t = typename BlockT::hash_t

Constructor & Destructor Documentation

BlockIteratorImpl()

template<typename BlockT >

altintegration::adaptors::BlockIteratorImpl< BlockT >::BlockIteratorImpl ( std::shared_ptr< StorageIterator >  it, const AltChainParams &  params  )

inline

Definition at line 91 of file block_provider_impl.hpp.

      : it_(std::move(it)), params_(params) {}

Member Function Documentation

key()

template<typename BlockT >

bool altintegration::adaptors::BlockIteratorImpl< BlockT >::key ( typename BlockT::hash_t &  out ) const

inlineoverridevirtual

Parameters

[out]

out

block hash

Returns

true if we can successfully return key, false otherwise

Implements altintegration::BlockIterator< BlockT >.

Definition at line 115 of file block_provider_impl.hpp.

                                                      {
    std::vector<uint8_t> bytes;
    if (!it_->key(bytes)) {
      return false;
    }
    // remove prefix
    out = {bytes.begin() + 1, bytes.end()};
    return true;
  }

next()

template<typename BlockT >

void altintegration::adaptors::BlockIteratorImpl< BlockT >::next ( )

inlineoverridevirtual

Implements altintegration::BlockIterator< BlockT >.

Definition at line 95 of file block_provider_impl.hpp.

{ it_->next(); }

seek_start()

template<typename BlockT >

void altintegration::adaptors::BlockIteratorImpl< BlockT >::seek_start ( )

inlineoverridevirtual

Implements altintegration::BlockIterator< BlockT >.

Definition at line 132 of file block_provider_impl.hpp.

                             {
    static const uint8_t prefix = block_key<BlockT>({})[0];
 
    it_->seek({prefix});
  }

valid()

template<typename BlockT >

bool altintegration::adaptors::BlockIteratorImpl< BlockT >::valid ( ) const

inlineoverridevirtual

Returns

true if the iterator is valid, false otherwise

Implements altintegration::BlockIterator< BlockT >.

Definition at line 125 of file block_provider_impl.hpp.

                              {
    static const uint8_t prefix = block_key<BlockT>({})[0];
 
    std::vector<uint8_t> key;
    return it_->valid() && it_->key(key) && !key.empty() && key[0] == prefix;
  }

value()

template<typename BlockT >

bool altintegration::adaptors::BlockIteratorImpl< BlockT >::value ( StoredBlockIndex< BlockT > &  out ) const

inlineoverridevirtual

Parameters

[out]

out

block, altintegration::StoredBlockIndex

Returns

true if we can successfully return value, false otherwise

Implements altintegration::BlockIterator< BlockT >.

Definition at line 97 of file block_provider_impl.hpp.

                                                           {
    std::vector<uint8_t> bytes;
    if (!it_->value(bytes)) {
      return false;
    }
 
    ValidationState dummy;
    if (!DeserializeFromVbkEncoding<StoredBlockIndex<BlockT>>(
            bytes, out, dummy)) {
      VBK_LOG_ERROR("Can not deserialize StoredBlockIndex<%s>: %s",
                    BlockT::name(),
                    dummy.toString());
      return false;
    }
 
    return true;
  }

---

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

• include/veriblock/pop/storage/adaptors/block_provider_impl.hpp