Skip to content
This repository has been archived by the owner on May 14, 2022. It is now read-only.

Commit

Permalink
docs: more description
Browse files Browse the repository at this point in the history
  • Loading branch information
Dmitry Sedykh committed Aug 24, 2018
1 parent 9584871 commit bcdde17
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions db.go
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,8 @@ func open(filename string) (db *DB, err error) {
return db, nil
}

// String возвращает имя хранилища.
// String возвращает имя файла с хранилища с префиксом "db:" и обычно
// используется для отладки или вывода в лог имени хранилища.
func (db *DB) String() string {
return fmt.Sprintf("db:%s", db.Path())
}
Expand Down Expand Up @@ -187,15 +188,17 @@ func (db *DB) close() (err error) {
return err
}

// Close закрывает хранилище.
// Close закрывает хранилище. Если специально не задано не выполнять
// синхронизацию, то при этом происходит принудительный сброс кешей в файл.
// Повторное выполнение уже закрытого хранилища не приводит к ошибке.
func (db *DB) Close() error {
mu.Lock()
delete(dbs, db.f.Name()) // удаляем из списка открытых
mu.Unlock()
return db.close()
}

// Count возвращает количество записей в хранилище.
// Count возвращает количество записей (активных ключей данных) в хранилище.
func (db *DB) Count() uint32 {
db.mu.RLock()
defer db.mu.RUnlock()
Expand Down Expand Up @@ -244,7 +247,9 @@ func (db *DB) get(key string) ([]byte, error) {
}

// Get возвращает данные, сохраненные с указанным ключом. Если данные с таким
// ключем в хранилище не сохранены, то возвращается ошибка ErrNotFound.
// ключем в хранилище не сохранены, то возвращается ошибка ErrNotFound и nil
// в качестве значения. Для пустого значения (nil) всегда возвращается пуcтой
// массив байт ([]byte{}).
func (db *DB) Get(key string) ([]byte, error) {
db.mu.RLock()
defer db.mu.RUnlock()
Expand Down

0 comments on commit bcdde17

Please sign in to comment.