builtin

package
v1.21.0 Latest Latest
Warning

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

Go to latest
Published: Jul 13, 2026 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

Package log implements a simple logging package. It defines a type, Builtin, with methods for formatting output. The Fatal methods call os.Exit(1) after writing the log message. The Panic methods call panic after writing the log message.

Package builtin contains the Golang's built-in logger with only one change: Don't always add a newline. If someday they fix that, remove this internal package.

See this https://github.com/golang/go/issues/16564 for more info.

Index

Constants

View Source
const (
	DefaultCallDepth = 2

	Ldate         = 1 << iota     // the date in the local time zone: 2009/01/23
	Ltime                         // the time in the local time zone: 01:23:23
	Lmicroseconds                 // microsecond resolution: 01:23:23.123123.  assumes Ltime.
	Llongfile                     // full file name and line number: /a/b/c/d.go:23
	Lshortfile                    // final file name element and line number: d.go:23. overrides Llongfile
	LUTC                          // if Ldate or Ltime is set, use UTC rather than the local time zone
	Lmsgprefix                    // move the "prefix" from the beginning of the line to before the message
	LstdFlags     = Ldate | Ltime // initial values for the standard logger
)

These flags define which text to prefix to each log entry generated by the Builtin. Bits are or'ed together to control what's printed. With the exception of the Lmsgprefix flag, there is no control over the order they appear (the order listed here) or the format they present (as described in the comments). The prefix is followed by a colon only when Llongfile or Lshortfile is specified. For example, flags Ldate | Ltime (or LstdFlags) produce,

2009/01/23 01:23:23 message

while flags Ldate | Ltime | Lmicroseconds | Llongfile produce,

2009/01/23 01:23:23.123123 /a/b/c/d.go:23: message

Variables

This section is empty.

Functions

This section is empty.

Types

type Builtin

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

A Builtin represents an active logging object that generates lines of output to an io.Writer. Each logging operation makes a single call to the Writer's Write method. A Builtin can be used simultaneously from multiple goroutines; it guarantees to serialize access to the Writer.

func NewBuiltin

func NewBuiltin(out io.Writer, prefix string, flag int) *Builtin

NewBuiltin creates a new Builtin. The out variable sets the destination to which log data will be written. The prefix appears at the beginning of each generated log line, or after the log header if the Lmsgprefix flag is provided. The flag argument defines the logging properties.

func (*Builtin) Fatal

func (l *Builtin) Fatal(v ...interface{})

Fatal is equivalent to l.Print() followed by a call to os.Exit(1).

func (*Builtin) Fatalf

func (l *Builtin) Fatalf(format string, v ...interface{})

Fatalf is equivalent to l.Printf() followed by a call to os.Exit(1).

func (*Builtin) Fatalln

func (l *Builtin) Fatalln(v ...interface{})

Fatalln is equivalent to l.Println() followed by a call to os.Exit(1).

func (*Builtin) Flags

func (l *Builtin) Flags() int

Flags returns the output flags for the logger. The flag bits are Ldate, Ltime, and so on.

func (*Builtin) OutputBuiltin

func (l *Builtin) OutputBuiltin(calldepth int, s string) error

OutputBuiltin writes the output for a logging event. The string s contains the text to print after the prefix specified by the flags of the Builtin. Calldepth is used to recover the PC and is provided for generality, although at the moment on all pre-defined paths it will be 2.

func (*Builtin) Panic

func (l *Builtin) Panic(v ...interface{})

Panic is equivalent to l.Print() followed by a call to panic().

func (*Builtin) Panicf

func (l *Builtin) Panicf(format string, v ...interface{})

Panicf is equivalent to l.Printf() followed by a call to panic().

func (*Builtin) Panicln

func (l *Builtin) Panicln(v ...interface{})

Panicln is equivalent to l.Println() followed by a call to panic().

func (*Builtin) Prefix

func (l *Builtin) Prefix() string

Prefix returns the output prefix for the logger.

func (*Builtin) Print

func (l *Builtin) Print(v ...interface{})

Print calls l.OutputBuiltin to print to the logger. Arguments are handled in the manner of fmt.Print.

func (*Builtin) Printf

func (l *Builtin) Printf(format string, v ...interface{})

Printf calls l.OutputBuiltin to print to the logger. Arguments are handled in the manner of fmt.Printf.

func (*Builtin) Println

func (l *Builtin) Println(v ...interface{})

Println calls l.OutputBuiltin to print to the logger. Arguments are handled in the manner of fmt.Println.

func (*Builtin) SetFlags

func (l *Builtin) SetFlags(flag int)

SetFlags sets the output flags for the logger. The flag bits are Ldate, Ltime, and so on.

func (*Builtin) SetOutput

func (l *Builtin) SetOutput(w io.Writer)

SetOutput sets the output destination for the logger.

func (*Builtin) SetPrefix

func (l *Builtin) SetPrefix(prefix string)

SetPrefix sets the output prefix for the logger.

func (*Builtin) Writer

func (l *Builtin) Writer() io.Writer

Writer returns the output destination for the logger.

Jump to

Keyboard shortcuts

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