stdout

Documentation

Overview

Package printer defines printer output and error carriers. These are mainly useful for debugging.

Index

• func BytePrinter(in []byte) (out string)
• func WrapperPrinter(w *flow.Wrapper) (out string)
• type Carrier
  • func New(ctx context.Context, logger journal.Logger, config *Config) (*Carrier, error)
  • func (c *Carrier) ValidErrorCarrier() error
  • func (c *Carrier) WriteErr(message *flow.MessageContext) error
  • func (c *Carrier) WriteFail(message *flow.MessageContext) error
  • func (c *Carrier) WriteOutput(message *flow.MessageContext) error
• type Config

Functions

func BytePrinter

func BytePrinter(in []byte) (out string)

BytePrinter attempts to convert bytes to strings.

func WrapperPrinter

func WrapperPrinter(w *flow.Wrapper) (out string)

WrapperPrinter attempts to deserialise a wrapper protobuf and returns a formatted overview.

Types

type Carrier

type Carrier struct {
	Context      context.Context
	Logger       journal.Logger
	Deserialiser func(w *flow.Wrapper) (out string)
}

func New

func New(ctx context.Context, logger journal.Logger, config *Config) (*Carrier, error)

func (*Carrier) ValidErrorCarrier

func (c *Carrier) ValidErrorCarrier() error

func (*Carrier) WriteErr

func (c *Carrier) WriteErr(message *flow.MessageContext) error

func (*Carrier) WriteFail

func (c *Carrier) WriteFail(message *flow.MessageContext) error

func (*Carrier) WriteOutput

func (c *Carrier) WriteOutput(message *flow.MessageContext) error

type Config

type Config struct {
	// Deserialiser is the deserialisation function, it will get passed the byte array
	// that is being passed to the output and returns a string to be printed.
	// Defaults to BytePrinter
	Deserialiser func(w *flow.Wrapper) (out string)
}

Config structure for the printer carriers.