tickertape

Documentation

Overview

Package tickertape provides an implenetation of a concurrency-safe 'ticker tape' of current information during a running program - that is, repeatedly updating the same line with new information.

Index

• Constants
• func Print(args ...interface{})
• func Printf(format string, args ...interface{})
• type TickerTape
  • func (ticker *TickerTape) Close() error
  • func (ticker *TickerTape) Print(args ...interface{}) bool
  • func (ticker *TickerTape) Printf(format string, args ...interface{}) bool
  • func (ticker *TickerTape) Write(b []byte) (n int, err error)

Constants

const (
	ErrNotListening  errorlib.ErrorString = "tickertape is not listening"
	ErrAlreadyClosed errorlib.ErrorString = "cannot print to a closed tickertape"
)

Functions

func Print

func Print(args ...interface{})

Print to the internal ticker.

func Printf

func Printf(format string, args ...interface{})

Printf to the internal ticker.

Types

type TickerTape

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

TickerTape is a struct for printing progress information one at a time, on the same line.

func (*TickerTape) Close

func (ticker *TickerTape) Close() error

Close the tickertape.

func (*TickerTape) Print

func (ticker *TickerTape) Print(args ...interface{}) bool

Print a line through the ticker like fmt.Print

func (*TickerTape) Printf

func (ticker *TickerTape) Printf(format string, args ...interface{}) bool

Printf prints to a ticker

func (*TickerTape) Write

func (ticker *TickerTape) Write(b []byte) (n int, err error)