storm

Documentation

Index

• Constants
• Variables
• func From(container *service.Container) (*storm.DB, error)
• func Must(container *service.Container) *storm.DB
• func ServiceProvider(funcs ...OptionFunc) service.Provider
• type Option
  • func DefaultOption() *Option
  • func MergeOption(opt *Option, funcs ...OptionFunc) *Option
• type OptionFunc
  • func WithInit(init bool) OptionFunc
  • func WithObjects(objects ...interface{}) OptionFunc
  • func WithPath(path string) OptionFunc
  • func WithReIndex(reindex bool) OptionFunc

Constants

const ServiceName service.Name = "storm"

Variables

var (
	ErrNotFound = storm.ErrNotFound
)

Functions

func From

func From(container *service.Container) (*storm.DB, error)

From retrieves the storm service in the given container

func Must

func Must(container *service.Container) *storm.DB

Must retrieves the storm service in the given container or panic otherwise

func ServiceProvider

func ServiceProvider(funcs ...OptionFunc) service.Provider

Types

type Option

type Option struct {
	Path    string
	Objects []interface{}
	ReIndex bool
	Init    bool
}

func DefaultOption

func DefaultOption() *Option

func MergeOption

func MergeOption(opt *Option, funcs ...OptionFunc) *Option

type OptionFunc

type OptionFunc func(*Option)

func WithInit

func WithInit(init bool) OptionFunc

func WithObjects

func WithObjects(objects ...interface{}) OptionFunc

func WithPath

func WithPath(path string) OptionFunc

func WithReIndex

func WithReIndex(reindex bool) OptionFunc