kvapi

Documentation

Index

• Variables
• type APIError
  • func (a *APIError) Error() string
  • func (a *APIError) Unwrap() error
• type AuthError
  • func (a *AuthError) Error() string
• type Client
• type ConflictError
  • func (a *ConflictError) Error() string
• type GetRequest
• type GetResponse
• type SetRequest
• type SetResponse

Variables

var ErrKeyNotFound = errors.New("key not found")

Types

type APIError

type APIError struct {
	Method string
	Err    error
}

func (*APIError) Error

func (a *APIError) Error() string

func (*APIError) Unwrap

func (a *APIError) Unwrap() error

type AuthError

type AuthError struct {
	Msg string
}

func (*AuthError) Error

func (a *AuthError) Error() string

type Client

type Client interface {
	// Get the value of key.
	Get(req *GetRequest) (*GetResponse, error)

	// Set key to hold given value.
	Set(rsp *SetRequest) (*SetResponse, error)
}

type ConflictError

type ConflictError struct {
	ProvidedVersion, ExpectedVersion uuid.UUID
}

func (*ConflictError) Error

func (a *ConflictError) Error() string

type GetRequest

type GetRequest struct {
	Key string
}

type GetResponse

type GetResponse struct {
	Value   string
	Version uuid.UUID
}

type SetRequest

type SetRequest struct {
	Key, Value string

	// OldVersion field is checked before updating value.
	//
	// When updating old value, OldVersion must specify uuid of currently stored value.
	// When creating new value, OldVersion must hold zero value of UUID.
	OldVersion, NewVersion uuid.UUID
}

type SetResponse

type SetResponse struct{}