store

package module

v0.0.0-...-f31bbc3 Latest Latest Go to latest Published: May 26, 2024 License: BSD-3-Clause Imports: 4 Imported by: 0

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

This section is empty.

This section is empty.

func Debug() bool

Debug toggles (enables/disables) debug output through Logger and returns either true if enabled or respectively false if disabled.

type Content struct {
	Name any
	Data any
	Date time.Time
}

Content contains the actual data.

type List []summary

List is replied on List() calls with metadata.

type Snapshot struct {
	Date time.Time
	Data []*Content
}

Snapshot contains the exported data and a timestamp of creation.

type Store struct {
	// Logger adds a prefix of "store: " by default.
	Logger *log.Logger
	// contains filtered or unexported fields
}

Store is the main datatype that holds runtime.

func New() *Store

New creates a new instance of store.

func (s *Store) Delete(key any) bool

Delete removes the item called by the given key and return true if the key existed.

func (s *Store) Export() *Snapshot

Export allows snapshots of store.

func (s *Store) Get(key any) (any, bool)

Get looks up items by the given key and returns the data and a found boolean.

func (s *Store) Import(snap *Snapshot) *Store

Import will simply add snapshot data to store.

func (s *Store) List() List

List returns all keys with corresponding last change date values in the store.

func (s *Store) Set(key, data any) bool

Set adds a new or overwrites an existing item in the store with the given key and data and returns the boolean value of replace.

func (s *Store) State(key any) (time.Time, bool)

State looks up the item by the given key and returns the change date and a found boolean.