outputTypes

Documentation

Overview

Package outputTypes includes all valid output types that Icarus supports. outputtypes use the internal processed calendar structure and format it for the output.

Index

• func GetOutputHelp() string
• func GetOutputTypes() map[string]BaseOutputType
• type BaseOutputType
• type CSVOutputType
  • func (t *CSVOutputType) Generate(calendar *ical.Calendar, writer io.Writer, options OutputOptions) error
  • func (*CSVOutputType) GetHelp() string
  • func (t *CSVOutputType) Initialize(parser *argparse.Parser) error
• type ICSOutputType
  • func (t *ICSOutputType) Generate(calendar *ical.Calendar, writer io.Writer, _ OutputOptions) error
  • func (t *ICSOutputType) GetHelp() string
  • func (t *ICSOutputType) Initialize(_ *argparse.Parser) error
• type ListOutputType
  • func (t *ListOutputType) Generate(calendar *ical.Calendar, writer io.Writer, options OutputOptions) error
  • func (t *ListOutputType) GetHelp() string
  • func (t *ListOutputType) Initialize(_ *argparse.Parser) error
• type OutputOptions
• type TableOutputType
  • func (t *TableOutputType) Generate(calendar *ical.Calendar, writer io.Writer, options OutputOptions) error
  • func (t *TableOutputType) GetHelp() string
  • func (t *TableOutputType) Initialize(_ *argparse.Parser) error

Functions

func GetOutputHelp

func GetOutputHelp() string

GetOutputHelp returns a formatted help string for all available output types

func GetOutputTypes

func GetOutputTypes() map[string]BaseOutputType

GetOutputTypes returns a list of enabled output types

Types

type BaseOutputType

type BaseOutputType interface {
	// Initialize can add arguments to the argument parser.
	Initialize(parser *argparse.Parser) error
	// Generate generates the output based on the given calendar and writes it to writer
	Generate(calendar *ical.Calendar, writer io.Writer, options OutputOptions) error
	// GetHelp returns a help string about what the output produces
	GetHelp() string
}

The BaseOutputType is the basic interface for all output types

type CSVOutputType

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

func (*CSVOutputType) Generate

func (t *CSVOutputType) Generate(calendar *ical.Calendar, writer io.Writer, options OutputOptions) error

func (*CSVOutputType) GetHelp

func (*CSVOutputType) GetHelp() string

func (*CSVOutputType) Initialize

func (t *CSVOutputType) Initialize(parser *argparse.Parser) error

type ICSOutputType

type ICSOutputType struct{}

The ICSOutputType converts the internal calendar into the standardizes ICS format

func (*ICSOutputType) Generate

func (t *ICSOutputType) Generate(calendar *ical.Calendar, writer io.Writer, _ OutputOptions) error

func (*ICSOutputType) GetHelp

func (t *ICSOutputType) GetHelp() string

func (*ICSOutputType) Initialize

func (t *ICSOutputType) Initialize(_ *argparse.Parser) error

type ListOutputType

type ListOutputType struct {
}

The ListOutputType converts the internal calendar into a table format

func (*ListOutputType) Generate

func (t *ListOutputType) Generate(calendar *ical.Calendar, writer io.Writer, options OutputOptions) error

func (*ListOutputType) GetHelp

func (t *ListOutputType) GetHelp() string

func (*ListOutputType) Initialize

func (t *ListOutputType) Initialize(_ *argparse.Parser) error

type OutputOptions

type OutputOptions struct {
	Columns []string
}

OutputOptions hold basic options for all output types

type TableOutputType

type TableOutputType struct {
}

The TableOutputType converts the internal calendar into a table format

func (*TableOutputType) Generate

func (t *TableOutputType) Generate(calendar *ical.Calendar, writer io.Writer, options OutputOptions) error

func (*TableOutputType) GetHelp

func (t *TableOutputType) GetHelp() string

func (*TableOutputType) Initialize

func (t *TableOutputType) Initialize(_ *argparse.Parser) error