writer

Documentation

Index

• func Write(report any, config OutputConfig, startedAt datetime.DateTime, ...) error
• type Format
  • func NewFormat(value FormatValue) Format
  • func (f Format) IsUnknown() bool
  • func (f Format) MarshalText() ([]byte, error)
  • func (f Format) String() string
  • func (f *Format) UnmarshalText(text []byte) error
• type FormatValue
  • func FormatValues() []FormatValue
• type OutputConfig
  • func NewOutputConfig(filePath *string, output Format) OutputConfig

Functions

func Write

func Write(
	report any,
	config OutputConfig,
	startedAt datetime.DateTime,
	completedAt *datetime.DateTime,
	status int,
	errorMessage *string,
) error

Types

type Format

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

func NewFormat

func NewFormat(value FormatValue) Format

func (Format) IsUnknown

func (f Format) IsUnknown() bool

func (Format) MarshalText

func (f Format) MarshalText() ([]byte, error)

func (Format) String

func (f Format) String() string

func (*Format) UnmarshalText

func (f *Format) UnmarshalText(text []byte) error

type FormatValue

type FormatValue string

const (
	JSON    FormatValue = "json"
	YAML    FormatValue = "yaml"
	SIGNAL  FormatValue = "signal"
	UNKNOWN FormatValue = "unknown"
)

func FormatValues

func FormatValues() []FormatValue

type OutputConfig

type OutputConfig struct {
	FilePath *string
	Output   Format
}

func NewOutputConfig

func NewOutputConfig(filePath *string, output Format) OutputConfig