ctrlengine

Documentation

Overview

Package ctrlengine implements the command engine for mutectrl.

Index

• Variables
• type CtrlEngine
  • func New() *CtrlEngine
  • func (ce *CtrlEngine) Close()
  • func (ce *CtrlEngine) Start(args []string) error

Variables

var ErrDeliveryFailed = errors.New("ctrlengine: delivery failed")

ErrDeliveryFailed is raised when the message delivery failed due to option --fail-delivery.

var ErrPassphrasesDiffer = errors.New("ctrlengine: passphrases differ")

ErrPassphrasesDiffer is raised when the supplied passphrases during a DB creation or rekey operation differ.

var ErrUserIDOwned = errors.New("user ID already owned")

ErrUserIDOwned is raised during UID message creation, if a user ID is already owned by the same user

var ErrUserIDTaken = errors.New("user ID already taken")

ErrUserIDTaken is raised during UID message creation, if a user ID is already taken by another user.

Types

type CtrlEngine

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

CtrlEngine abstracts a mutectrl command engine.

func New

func New() *CtrlEngine

New returns a new CtrlEngine.

func (*CtrlEngine) Close

func (ce *CtrlEngine) Close()

Close the underlying database of the CtrlEngine.

func (*CtrlEngine) Start

func (ce *CtrlEngine) Start(args []string) error

Start starts the CtrlEngine with the given args.