storedcounter

README

go-storedcounter

A simple thread safe persisted counter

Table of Contents

• Description
• Install
• Usage
• License

Description

The module provides a simple counter on top of a go-ipfs-datastore interface

Install

go get github.com/filecoin-project/go-storedcounter

Usage

Create/load a counter for a datastore and key:

import(
  "github.com/ipfs/go-datastore"
  "github.com/filecoin-project/go-storedcounter"
)

var ds datastore.Datastore
var name datastore.Key

storedCounter := storedcounter.New(ds, name)

Get the next value (will start at 0):

next := storedcCounter.Next()

License

Dual-licensed under MIT + Apache 2.0

Documentation

Index

• type StoredCounter
  • func New(ds datastore.Datastore, name datastore.Key) *StoredCounter
  • func (sc *StoredCounter) Next() (uint64, error)

Types

type StoredCounter

type StoredCounter struct {
	// contains filtered or unexported fields
}

StoredCounter is a counter that persists to a datastore as it increments

func New

func New(ds datastore.Datastore, name datastore.Key) *StoredCounter

New returns a new StoredCounter for the given datastore and key

func (*StoredCounter) Next

func (sc *StoredCounter) Next() (uint64, error)

Next returns the next counter value, updating it on disk in the process if no counter is present, it creates one and returns a 0 value