key

Documentation

Index

• Constants
• type Converter
• type ConverterPipeline
  • func NewConverterPipeline() *ConverterPipeline
  • func (p *ConverterPipeline) AddHook(hooks ...func(string) string) *ConverterPipeline
  • func (p *ConverterPipeline) Convert(pattern string) string
• type ErrKeyAlreadyExists
  • func NewErrKeyAlreadyExist(key Key) *ErrKeyAlreadyExists
  • func (e *ErrKeyAlreadyExists) Error() string
• type ErrKeyNotFound
  • func NewErrKeyNotFound(key Key) *ErrKeyNotFound
  • func (e *ErrKeyNotFound) Error() string
• type ErrSelectorKeyNotAllowed
  • func NewErrSelectorKeyNotAllowed(key Key) *ErrSelectorKeyNotAllowed
  • func (e *ErrSelectorKeyNotAllowed) Error() string
• type Key
  • func New(pattern string, converter Converter, validator Validator) *Key
  • func (k *Key) IsRaw() bool
  • func (k *Key) IsSelector() bool
  • func (k *Key) Size() int
• type Validator
• type ValidatorPipeline
  • func NewValidatorPipeline() *ValidatorPipeline
  • func (v *ValidatorPipeline) AddHook(hooks ...func(string) error) *ValidatorPipeline
  • func (v *ValidatorPipeline) Validate(pattern string) error

Constants

const (
	SelectorChar = '*'
)

Types

type Converter

type Converter interface {
	Convert(key string) string
}

handles the conversion of keys, queries and key to satisfiable formats for the repository

type ConverterPipeline

type ConverterPipeline struct {
	Hooks []func(string) string
}

implements Converter converts key in steps, in a pipeline manner

func NewConverterPipeline

func NewConverterPipeline() *ConverterPipeline

func (*ConverterPipeline) AddHook

func (p *ConverterPipeline) AddHook(hooks ...func(string) string) *ConverterPipeline

func (*ConverterPipeline) Convert

func (p *ConverterPipeline) Convert(pattern string) string

type ErrKeyAlreadyExists

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

error that is returned from the repository when a key already exists in the repository

func NewErrKeyAlreadyExist

func NewErrKeyAlreadyExist(key Key) *ErrKeyAlreadyExists

func (*ErrKeyAlreadyExists) Error

func (e *ErrKeyAlreadyExists) Error() string

type ErrKeyNotFound

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

error that is returned from the repository when a key is required and is not found

func NewErrKeyNotFound

func NewErrKeyNotFound(key Key) *ErrKeyNotFound

func (*ErrKeyNotFound) Error

func (e *ErrKeyNotFound) Error() string

type ErrSelectorKeyNotAllowed

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

error that is returned from the repository when a selector key cannot be accepted as input

func NewErrSelectorKeyNotAllowed

func NewErrSelectorKeyNotAllowed(key Key) *ErrSelectorKeyNotAllowed

func (*ErrSelectorKeyNotAllowed) Error

func (e *ErrSelectorKeyNotAllowed) Error() string

type Key

type Key string

func New

func New(pattern string, converter Converter, validator Validator) *Key

func (*Key) IsRaw

func (k *Key) IsRaw() bool

func (*Key) IsSelector

func (k *Key) IsSelector() bool

func (*Key) Size

func (k *Key) Size() int

type Validator

type Validator interface {
	Validate(pattern string) error
}

validates the Pattern of keys

type ValidatorPipeline

type ValidatorPipeline struct {
	Hooks []func(string) error
}

implements Validator validates keys in steps, in a pipeline manner

func NewValidatorPipeline

func NewValidatorPipeline() *ValidatorPipeline

func (*ValidatorPipeline) AddHook

func (v *ValidatorPipeline) AddHook(hooks ...func(string) error) *ValidatorPipeline

func (*ValidatorPipeline) Validate

func (v *ValidatorPipeline) Validate(pattern string) error