export

Documentation

Index

• Variables
• type APIKey
  • func NewAPIKey(prime primeable) *APIKey
  • func (k *APIKey) Run(params APIKeyRunParams) error
• type APIKeyProvider
• type APIKeyRunParams
• type Env
  • func NewEnv(prime primeable) *Env
  • func (e *Env) Run() error
• type Export
  • func NewExport() *Export
  • func (e *Export) Run(cmd *captain.Command) error
• type JWT
  • func NewJWT(prime primeable) *JWT
  • func (j *JWT) Run(params *JWTParams) error
• type JWTParams
• type Log
  • func NewLog(prime primeable) *Log
  • func (l *Log) Run(params *LogParams) (rerr error)
• type LogParams
• type PrivateKey
  • func NewPrivateKey(prime primeable) *PrivateKey
  • func (p *PrivateKey) Run(params *PrivateKeyParams) error
• type PrivateKeyParams

Variables

var ErrInvalidLogIndex = errs.New("invalid index")

var ErrInvalidLogPrefix = errs.New("invalid log prefix")

var ErrLogNotFound = errs.New("log not found")

Types

type APIKey

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

APIKey manages the core dependencies for the primary APIKey logic.

func NewAPIKey

func NewAPIKey(prime primeable) *APIKey

NewAPIKey is a convenience construction function.

func (*APIKey) Run

func (k *APIKey) Run(params APIKeyRunParams) error

Run executes the primary APIKey logic.

type APIKeyProvider

type APIKeyProvider interface {
	NewAPIKey(string) (string, error)
}

APIKeyProvider describes the behavior required to obtain a new api key.

type APIKeyRunParams

type APIKeyRunParams struct {
	Name     string
	IsAuthed func() bool
}

APIKeyRunParams manages the request-specific parameters used to run the primary APIKey logic.

type Env

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

func NewEnv

func NewEnv(prime primeable) *Env

func (*Env) Run

func (e *Env) Run() error

type Export

type Export struct{}

func NewExport

func NewExport() *Export

func (*Export) Run

func (e *Export) Run(cmd *captain.Command) error

type JWT

type JWT struct {
	output.Outputer
	*authentication.Auth
}

func NewJWT

func NewJWT(prime primeable) *JWT

func (*JWT) Run

func (j *JWT) Run(params *JWTParams) error

Run processes the `export recipe` command.

type JWTParams

type JWTParams struct {
}

type Log

type Log struct {
	output.Outputer
}

func NewLog

func NewLog(prime primeable) *Log

func (*Log) Run

func (l *Log) Run(params *LogParams) (rerr error)

type LogParams

type LogParams struct {
	Prefix string
	Index  int
}

type PrivateKey

type PrivateKey struct {
	output.Outputer

	*authentication.Auth
	// contains filtered or unexported fields
}

func NewPrivateKey

func NewPrivateKey(prime primeable) *PrivateKey

func (*PrivateKey) Run

func (p *PrivateKey) Run(params *PrivateKeyParams) error

Run processes the `export recipe` command.

type PrivateKeyParams

type PrivateKeyParams struct {
}