log

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 16, 2019 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package log contains logging related functionality

Package log contains logging related functionality

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func IsTerminal

func IsTerminal(w io.Writer) bool

IsTerminal returns true if the writer w is a terminal

func LevelsString

func LevelsString() string

LevelsString returns a string representing all log levels this is useful for help text / flag info

Types

type Status

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

Status is used to track ongoing status in a CLI, with a nice loading spinner when attached to a terminal

func NewStatus

func NewStatus(w io.Writer) *Status

NewStatus creates a new default Status

func (*Status) End

func (s *Status) End(success bool)

End completes the current status, ending any previous spinning and marking the status as success or failure

func (*Status) MaybeWrapLogrus

func (s *Status) MaybeWrapLogrus(logger *logrus.Logger)

MaybeWrapLogrus behaves like MaybeWrapWriter for a logrus logger

func (*Status) MaybeWrapWriter

func (s *Status) MaybeWrapWriter(w io.Writer) io.Writer

MaybeWrapWriter returns a StatusFriendlyWriter for w IFF w and spinner's output are a terminal, otherwise it returns w

func (*Status) Start

func (s *Status) Start(status string)

Start starts a new phase of the status, if attached to a terminal there will be a loading spinner with this status

func (*Status) WrapLogrus

func (s *Status) WrapLogrus(logger *logrus.Logger)

WrapLogrus wraps a logrus logger's output with a StatusFriendlyWriter

func (*Status) WrapWriter

func (s *Status) WrapWriter(w io.Writer) io.Writer

WrapWriter returns a StatusFriendlyWriter for w

type StatusFriendlyWriter

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

StatusFriendlyWriter is used to wrap another Writer to make it toggle the status spinner before and after writes so that they do not collide

func (*StatusFriendlyWriter) Write

func (ww *StatusFriendlyWriter) Write(p []byte) (n int, err error)

Directories

Path Synopsis
Package fidget implements CLI functionality for bored users waiting for results
Package fidget implements CLI functionality for bored users waiting for results

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL