store

Documentation

Overview

Package store handles interaction with the backing store.

Index

• Variables
• type GetSetter
• type Getter
• type JSONStore
  • func Get(settings config.Settings) (JSONStore, error)
  • func (j *JSONStore) Get(key string, i interface{}) error
  • func (j *JSONStore) Set(key string, i interface{}) error
• type Locking
  • func (l *Locking) Get(key string) (string, error)
  • func (l *Locking) Set(key string, data string) error
• type Memory
  • func (m *Memory) Get(key string) (string, error)
  • func (m *Memory) Set(key, data string) error
• type Setter

Examples

• JSONStore.Get
• Locking.Get
• Memory.Get

Variables

var ErrInvalidStoreConfig = errors.New("invalid store config")

ErrInvalidStoreConfig is returned if the bot is started with a store config name it doesn't recognise.

var ErrNoBackingStore = errors.New("no backing store set")

ErrNoBackingStore is returned if no backing store is set on the Locking store.

Types

type GetSetter

type GetSetter interface {
	Getter
	Setter
}

GetSetter types can Get and Set from a backing store.

type Getter

type Getter interface {
	// Get data from the backing store.
	Get(key string) (string, error)
}

Getter types can get data from the backing store.

type JSONStore

type JSONStore struct {
	BackingStore GetSetter
}

JSONStore stores JSON documents, converting them to strings for the backing store.

func Get

func Get(settings config.Settings) (JSONStore, error)

Get the backing store to use.

func (*JSONStore) Get

func (j *JSONStore) Get(key string, i interface{}) error

Get data from JSON stored in the backing store, marshalling the JSON into the given pointer.

Example

package main

import (
	"fmt"

	"bitbucket.org/idomdavis/gobot/store"
)

func main() {
	var (
		out  string
		zero int
	)

	s := store.JSONStore{BackingStore: &store.Memory{}}

	_ = s.Set("k", "in")
	_ = s.Get("k", &out)

	if err := s.Get("unset", &zero); err != nil {
		fmt.Println(err)
	}

	fmt.Println(out)
	fmt.Println(zero)

}

Output:

in
0

func (*JSONStore) Set

func (j *JSONStore) Set(key string, i interface{}) error

Set a type in the store marshalling it to JSON for storage.

type Locking

type Locking struct {
	BackingStore GetSetter
	// contains filtered or unexported fields
}

Locking store single threads access to a store.

func (*Locking) Get

func (l *Locking) Get(key string) (string, error)

Get data from the store. The store is locked while being accessed.

Example

package main

import (
	"fmt"

	"bitbucket.org/idomdavis/gobot/store"
)

func main() {
	s := store.Locking{BackingStore: &store.Memory{}}

	_ = s.Set("k", "v")

	v, _ := s.Get("k")

	fmt.Println(v)

}

Output:

v

func (*Locking) Set

func (l *Locking) Set(key string, data string) error

Set data on the store. The store is locked while being accessed.

type Memory

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

Memory store primarily used for testing.

func (*Memory) Get

func (m *Memory) Get(key string) (string, error)

Get data from the in memory store.

Example

package main

import (
	"fmt"

	"bitbucket.org/idomdavis/gobot/store"
)

func main() {
	s := store.Memory{}

	_ = s.Set("k", "v")
	v, _ := s.Get("k")

	fmt.Println(v)

}

Output:

v

func (*Memory) Set

func (m *Memory) Set(key, data string) error

Set data into the in memory store.

type Setter

type Setter interface {
	// Set data in the backing store on the given key.
	Set(key, data string) error
}

Setter types can set data into the backing store.