common

Documentation

Overview

Package common contains common properties used by the subpackages.

Index

• Constants
• Variables
• func SetLogger(logger Logger)
• func UtcTimeFormat(t _c.Time) string
• type ConsoleLogger
  • func NewConsoleLogger(logLevel LogLevel) *ConsoleLogger
  • func (_be ConsoleLogger) Debug(format string, args ...interface{})
  • func (_bg ConsoleLogger) Error(format string, args ...interface{})
  • func (_bbg ConsoleLogger) Info(format string, args ...interface{})
  • func (_bd ConsoleLogger) IsLogLevel(level LogLevel) bool
  • func (_ead ConsoleLogger) Notice(format string, args ...interface{})
  • func (_cd ConsoleLogger) Trace(format string, args ...interface{})
  • func (_dc ConsoleLogger) Warning(format string, args ...interface{})
• type DummyLogger
  • func (DummyLogger) Debug(format string, args ...interface{})
  • func (DummyLogger) Error(format string, args ...interface{})
  • func (DummyLogger) Info(format string, args ...interface{})
  • func (DummyLogger) IsLogLevel(level LogLevel) bool
  • func (DummyLogger) Notice(format string, args ...interface{})
  • func (DummyLogger) Trace(format string, args ...interface{})
  • func (DummyLogger) Warning(format string, args ...interface{})
• type LogLevel
• type Logger
• type WriterLogger
  • func NewWriterLogger(logLevel LogLevel, writer _df.Writer) *WriterLogger
  • func (_dag WriterLogger) Debug(format string, args ...interface{})
  • func (_ad WriterLogger) Error(format string, args ...interface{})
  • func (_ab WriterLogger) Info(format string, args ...interface{})
  • func (_gdf WriterLogger) IsLogLevel(level LogLevel) bool
  • func (_dae WriterLogger) Notice(format string, args ...interface{})
  • func (_fcag WriterLogger) Trace(format string, args ...interface{})
  • func (_ae WriterLogger) Warning(format string, args ...interface{})

Constants

const Version = "\u0033\u002e\u0034\u0037\u002e\u0030"

Variables

var ReleasedAt = _c.Date(_daf, _dba, _aga, _ef, _dbaa, 0, 0, _c.UTC)

Functions

func SetLogger

func SetLogger(logger Logger)

SetLogger sets 'logger' to be used by the unidoc unipdf library.

func UtcTimeFormat

func UtcTimeFormat(t _c.Time) string

UtcTimeFormat returns a formatted string describing a UTC timestamp.

Types

type ConsoleLogger

type ConsoleLogger struct{ LogLevel LogLevel }

ConsoleLogger is a logger that writes logs to the 'os.Stdout'

func NewConsoleLogger

func NewConsoleLogger(logLevel LogLevel) *ConsoleLogger

NewConsoleLogger creates new console logger.

func (ConsoleLogger) Debug

func (_be ConsoleLogger) Debug(format string, args ...interface{})

Debug logs debug message.

func (ConsoleLogger) Error

func (_bg ConsoleLogger) Error(format string, args ...interface{})

Error logs error message.

func (ConsoleLogger) Info

func (_bbg ConsoleLogger) Info(format string, args ...interface{})

Info logs info message.

func (ConsoleLogger) IsLogLevel

func (_bd ConsoleLogger) IsLogLevel(level LogLevel) bool

IsLogLevel returns true if log level is greater or equal than `level`. Can be used to avoid resource intensive calls to loggers.

func (ConsoleLogger) Notice

func (_ead ConsoleLogger) Notice(format string, args ...interface{})

Notice logs notice message.

func (ConsoleLogger) Trace

func (_cd ConsoleLogger) Trace(format string, args ...interface{})

Trace logs trace message.

func (ConsoleLogger) Warning

func (_dc ConsoleLogger) Warning(format string, args ...interface{})

Warning logs warning message.

type DummyLogger

type DummyLogger struct{}

DummyLogger does nothing.

func (DummyLogger) Debug

func (DummyLogger) Debug(format string, args ...interface{})

Debug does nothing for dummy logger.

func (DummyLogger) Error

func (DummyLogger) Error(format string, args ...interface{})

Error does nothing for dummy logger.

func (DummyLogger) Info

func (DummyLogger) Info(format string, args ...interface{})

Info does nothing for dummy logger.

func (DummyLogger) IsLogLevel

func (DummyLogger) IsLogLevel(level LogLevel) bool

IsLogLevel returns true from dummy logger.

func (DummyLogger) Notice

func (DummyLogger) Notice(format string, args ...interface{})

Notice does nothing for dummy logger.

func (DummyLogger) Trace

func (DummyLogger) Trace(format string, args ...interface{})

Trace does nothing for dummy logger.

func (DummyLogger) Warning

func (DummyLogger) Warning(format string, args ...interface{})

Warning does nothing for dummy logger.

type LogLevel

type LogLevel int

LogLevel is the verbosity level for logging.

const (
	LogLevelTrace   LogLevel = 5
	LogLevelDebug   LogLevel = 4
	LogLevelInfo    LogLevel = 3
	LogLevelNotice  LogLevel = 2
	LogLevelWarning LogLevel = 1
	LogLevelError   LogLevel = 0
)

type Logger

type Logger interface {
	Error(_da string, _e ...interface{})
	Warning(_ea string, _gf ...interface{})
	Notice(_af string, _fe ...interface{})
	Info(_de string, _eab ...interface{})
	Debug(_b string, _bb ...interface{})
	Trace(_cf string, _fee ...interface{})
	IsLogLevel(_gd LogLevel) bool
}

Logger is the interface used for logging in the unipdf package.

var Log Logger = DummyLogger{}

type WriterLogger

type WriterLogger struct {
	LogLevel LogLevel
	Output   _df.Writer
}

WriterLogger is the logger that writes data to the Output writer

func NewWriterLogger

func NewWriterLogger(logLevel LogLevel, writer _df.Writer) *WriterLogger

NewWriterLogger creates new 'writer' logger.

func (WriterLogger) Debug

func (_dag WriterLogger) Debug(format string, args ...interface{})

Debug logs debug message.

func (WriterLogger) Error

func (_ad WriterLogger) Error(format string, args ...interface{})

Error logs error message.

func (WriterLogger) Info

func (_ab WriterLogger) Info(format string, args ...interface{})

Info logs info message.

func (WriterLogger) IsLogLevel

func (_gdf WriterLogger) IsLogLevel(level LogLevel) bool

IsLogLevel returns true if log level is greater or equal than `level`. Can be used to avoid resource intensive calls to loggers.

func (WriterLogger) Notice

func (_dae WriterLogger) Notice(format string, args ...interface{})

Notice logs notice message.

func (WriterLogger) Trace

func (_fcag WriterLogger) Trace(format string, args ...interface{})

Trace logs trace message.

func (WriterLogger) Warning

func (_ae WriterLogger) Warning(format string, args ...interface{})

Warning logs warning message.