log

Documentation

Overview

Package log defines the logger interface used in rsync library.

Index

• func Printf(msg string, a ...any)
• func SetLogger(logger Logger)
• type Logger
  • func Default() Logger

Functions

func Printf

func Printf(msg string, a ...any)

Printf logs message to the default logger.

func SetLogger

func SetLogger(logger Logger)

SetLogger overrides the default logger to use in rsync. This should be call from the very beggining of the program.

Types

type Logger

type Logger interface {
	// Printf logs message to the underlying log output. Arguments are handled in the manner of fmt.Printf.
	Printf(msg string, a ...any)

	Output(calldepth int, s string) error
}

Logger is an interface that allows specifying your own logger. By default, the Go log package is used, which prints to stderr.

func Default

func Default() Logger

Default returns the global logger instance.