go_logger

package module
v0.4.9 Latest Latest
Warning

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

 Go to latest Published: Oct 4, 2025 License: GPL-3.0 Imports: 8 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// HeaderSeparator is the header separator
	HeaderSeparator = gostringsseparator.NewRepeatedContent(gostringsseparator.Space)

	// StatusSeparator is the status separator
	StatusSeparator = gostringsseparator.NewRepeatedContent(gostringsseparator.Space)

	// DescriptionSeparator is the description separator
	DescriptionSeparator = gostringsseparator.NewMultiline(
		gostringsseparator.Space,
		gostringsseparator.NewLine,
		1,
	)

	// MessageSeparator is the message separator
	MessageSeparator = gostringsseparator.Space

	// AddCharactersFn is the add characters function
	AddCharactersFn = gostringsadd.Brackets
)
View Source 
var (
	ErrNilLogger = errors.New("logger cannot be nil")
)

Functions

This section is empty.

Types

type DefaultLogger 

type DefaultLogger struct{}

DefaultLogger is a logger that logs messages

func NewDefaultLogger 

func NewDefaultLogger() *DefaultLogger

NewDefaultLogger creates a new logger

Returns:

  • *DefaultLogger: the new logger

func (DefaultLogger) BuildAndLog added in v0.4.0 

func (d DefaultLogger) BuildAndLog(
	header, subheader string,
	details *[]string,
	status gologgerstatus.Status,
)

BuildAndLog builds a message and logs it

Parameters:

  • header: the header of the message
  • subheader: the subheader of the message
  • details: the details of the message
  • status: the status of the message

func (DefaultLogger) Critical added in v0.4.0 

func (d DefaultLogger) Critical(header, subheader string, details *[]string)

Critical logs a critical message

Parameters:

  • header: the header of the message
  • subheader: the subheader of the message
  • details: the details of the message

func (DefaultLogger) Debug added in v0.4.0 

func (d DefaultLogger) Debug(header, subheader string, details *[]string)

Debug logs a debug message

Parameters:

  • header: the header of the message
  • subheader: the subheader of the message
  • details: the details of the message

func (DefaultLogger) Error added in v0.4.0 

func (d DefaultLogger) Error(header, subheader string, errors *[]error)

Error logs an error message

Parameters:

  • header: the header of the message
  • subheader: the subheader of the message
  • errors: the errors of the message

func (DefaultLogger) Info added in v0.4.0 

func (d DefaultLogger) Info(header, subheader string, details *[]string)

Info logs an info message

Parameters:

  • header: the header of the message
  • subheader: the subheader of the message
  • details: the details of the message

func (DefaultLogger) Log added in v0.4.0 

func (d DefaultLogger) Log(message *Message)

Log logs a message

Parameters:

  • message: the message to log

func (DefaultLogger) Warning added in v0.4.0 

func (d DefaultLogger) Warning(header, subheader string, details *[]string)

Warning logs a warning message

Parameters:

  • header: the header of the message
  • subheader: the subheader of the message
  • details: the details of the message

type Logger 

type Logger interface {
	Log(message *Message)
	Info(header, subheader string, details *[]string)
	Error(header, subheader string, errors *[]error)
	Debug(header, subheader string, details *[]string)
	Critical(header, subheader string, details *[]string)
	Warning(header, subheader string, details *[]string)
}

Logger is an interface for logging messages

type Message added in v0.4.0 

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

Message struct

func NewMessage added in v0.4.0 

func NewMessage(
	header, subheader string,
	description *[]string,
	status gologgerstatus.Status,
) *Message

NewMessage creates a new message

Parameters:

  • header: the header of the message
  • subheader: the subheader of the message
  • description: the description of the message
  • status: the status of the message

Returns:

  • *Message: the new message

func (Message) Status added in v0.4.2 

func (m Message) Status() gologgerstatus.Status

Status returns the status of a message

Returns:

  • gologgerstatus.Status: the status of the message

func (Message) String added in v0.4.0 

func (m Message) String() string

String gets the string representation of a message

Returns:

  • string: the string representation of the message

Source Files

View all Source files

Directories

Path Synopsis
named

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.