Made mtdbconverter pass golint by adding the missing comments.

This commit is contained in:
Sascha L. Teichmann
2016-04-24 18:37:08 +02:00
parent 67a16e2d3e
commit 7ac3c67e63
2 changed files with 19 additions and 1 deletions

View File

@@ -13,6 +13,7 @@ import (
)
type (
// LevelDBBlockProducer is a helper to fetch blocks from a LevelDB.
LevelDBBlockProducer struct {
db *leveldb.DB
opts *leveldb.Options
@@ -22,6 +23,7 @@ type (
decoder common.KeyDecoder
}
// LevelDBBlockConsumer is a helper to store blocks in a LevelDB.
LevelDBBlockConsumer struct {
db *leveldb.DB
opts *leveldb.Options
@@ -31,6 +33,7 @@ type (
}
)
// NewLevelDBBlockProducer returns a new helper to fetch blocks from a LevelDB.
func NewLevelDBBlockProducer(path string,
splitter common.KeySplitter,
decoder common.KeyDecoder) (ldbp *LevelDBBlockProducer, err error) {
@@ -65,6 +68,7 @@ func NewLevelDBBlockProducer(path string,
return
}
// Close closes a helper to fetch blocks from a LevelDB.
func (ldbp *LevelDBBlockProducer) Close() error {
if ldbp.iterator != nil {
ldbp.iterator.Close()
@@ -75,6 +79,7 @@ func (ldbp *LevelDBBlockProducer) Close() error {
return nil
}
// Next fetches the next block from a LevelDB.
func (ldbp *LevelDBBlockProducer) Next(block *common.Block) (err error) {
if ldbp.iterator == nil {
err = common.ErrNoMoreBlocks
@@ -98,6 +103,7 @@ func (ldbp *LevelDBBlockProducer) Next(block *common.Block) (err error) {
return
}
// NewLevelDBBlockConsumer returns a new helper to store blocks in a LevelDB.
func NewLevelDBBlockConsumer(
path string,
joiner common.KeyJoiner,
@@ -120,6 +126,7 @@ func NewLevelDBBlockConsumer(
return
}
// Close closes a helper to store blocks in a LevelDB.
func (ldbc *LevelDBBlockConsumer) Close() error {
ldbc.wo.Close()
ldbc.db.Close()
@@ -127,6 +134,7 @@ func (ldbc *LevelDBBlockConsumer) Close() error {
return nil
}
// Consume stores a block in LevelDB.
func (ldbc *LevelDBBlockConsumer) Consume(block *common.Block) (err error) {
var encodedKey []byte
if encodedKey, err = ldbc.encoder(ldbc.joiner(block.Coord)); err != nil {