commands

Documentation

Overview

Package commands implements the processing of the command line flags and processing of the encryption operation.

Index

• Variables
• func Encrypt(flags Flags, dst io.Writer, src io.Reader, network *http.Network) error
• func PrintUsage(log *log.Logger)
• type DurationMultiplier
• type Flags
  • func Parse() (Flags, error)

Variables

var ErrDuplicateDuration = errors.New("you cannot use the same duration unit specifier twice in one duration")

var ErrInvalidDurationMultiplier = errors.New("must contain a multiplier, e.g. 1d not just d")

var ErrInvalidDurationType = errors.New("unsupported duration type - note: drand can only support as short as seconds")

var ErrInvalidDurationValue = errors.New("the duration you entered is either in the past or was too large and would cause an overflow")

Functions

func Encrypt

func Encrypt(flags Flags, dst io.Writer, src io.Reader, network *http.Network) error

Encrypt performs the encryption operation. This requires the implementation of an encoder for reading/writing to disk, a network for making calls to the drand network, and an encrypter for encrypting/decrypting the data.

func PrintUsage

func PrintUsage(log *log.Logger)

PrintUsage displays the usage information.

Types

type DurationMultiplier

type DurationMultiplier = int8

const (
	Second DurationMultiplier = iota
	Minute
	Hour
	Day
	Week
	Month
	Year
)

type Flags

type Flags struct {
	Encrypt  bool
	Decrypt  bool
	Force    bool
	Network  string
	Chain    string
	Round    uint64
	Duration string
	Output   string
	Armor    bool
}

Flags represent the values from the command line.

func Parse

func Parse() (Flags, error)

Parse will parse the environment variables and command line flags. The command line flags will overwrite environment variables. Validation takes place.