kvstore

package module

v0.0.0-...-4336eae Latest Latest Go to latest Published: Sep 20, 2016 License: MIT Imports: 5 Imported by: 4

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/LeKovr/kvstore

README ¶

kvstore

kvstore - simple in-memory key-value store with persistense.

Features

setter Expire()

License

The MIT License (MIT), see LICENSE.

Documentation ¶

Overview ¶

Package kvstore is a simple key-value in memory store with persistense in json file

Index ¶

func Config(c *Flags) func(s *Store) error
type DataMap
type Flags
type Store
- func New(t StoreData, logger *log.Logger, options ...func(*Store) error) (*Store, error)
type StoreData

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Config ¶

func Config(c *Flags) func(s *Store) error

Config sets store config from flag var

Types ¶

type DataMap ¶

type DataMap map[string]StoreData

DataMap holds stored items

type Flags ¶

type Flags struct {
	StoreName string `long:"store_file" default:"store.json" description:"File to store sent codes at program exit"`
}

Flags is a package flags sample in form ready for use with github.com/jessevdk/go-flags

type Store ¶

type Store struct {
	Log    *log.Logger
	Config *Flags
	// contains filtered or unexported fields
}

Store holda all store attributes

func New ¶

func New(t StoreData, logger *log.Logger, options ...func(*Store) error) (*Store, error)

New - store constructor

func (*Store) Del ¶

func (s *Store) Del(key string) bool

Del deletes a key and returns true if it was founded

func (*Store) Destroy ¶

func (s *Store) Destroy()

Destroy saves store data into file

func (Store) Get ¶

func (s Store) Get(key string) (StoreData, bool)

Get returns data by key and true if it was founded

func (Store) Keys ¶

func (s Store) Keys() []string

Keys returns list of store keys

func (*Store) Load ¶

func (s *Store) Load()

Load reads json file and places it in store

func (*Store) Save ¶

func (s *Store) Save() bool

Save saves store into json file

func (*Store) Set ¶

func (s *Store) Set(key string, d StoreData) bool

Set saves data in store and returns true if key was rewritten

type StoreData ¶

type StoreData interface {
	//	UnmarshalJSON(b []byte) (err error)
	Init() (StoreData, error)
	Fetch(buf []byte) (StoreData, error)
}

StoreData interface holds sore item methods

Source Files ¶

View all Source files

kvstore.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL