converter

Documentation

Index

• Constants
• Variables
• type Converter
  • func New(options *Options) *Converter
  • func (p *Converter) Run() error
• type Options
  • func Default() *Options
  • func FromContext(ctx *ucli.Context) (*Options, error)

Constants

const (
	// FlagOutputFile is the flag for defining the output file location.
	FlagOutputFile  string = cli.FlagOutputFile
	FlagProgramName string = "program-name"
)

Variables

var DefaultOutputFile = "/dev/stdout"

DefaultOutputFile defines the default output location for the merger.

Types

type Converter

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

Converter is the main structure of this package.

func New

func New(options *Options) *Converter

New returns a new Converter instance.

func (*Converter) Run

func (p *Converter) Run() error

Run the Converter.

type Options

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

Options define all possible options for the puller.

func Default

func Default() *Options

Default returns a default options instance.

func FromContext

func FromContext(ctx *ucli.Context) (*Options, error)

FromContext can be used to create Options from an CLI context.