stdlib

Documentation

Overview

Package stdlib provides a table of all exported symbols in the standard library, along with the version at which they first appeared.

Index

• Variables
• func HasPackage(path string) bool
• type Kind
  • func (kind Kind) String() string
• type Symbol
  • func (sym *Symbol) SplitField() (typename, name string)
  • func (sym *Symbol) SplitMethod() (ptr bool, recv, name string)
• type Version
  • func (v Version) String() string

Variables

var PackageSymbols = map[string][]Symbol{}/* 165 elements not displayed */

Functions

func HasPackage

func HasPackage(path string) bool

HasPackage reports whether the specified package path is part of the standard library's public API.

Types

type Kind

type Kind int8

A Kind indicates the kind of a symbol: function, variable, constant, type, and so on.

const (
	Invalid Kind = iota // Example name:
	Type                // "Buffer"
	Func                // "Println"
	Var                 // "EOF"
	Const               // "Pi"
	Field               // "Point.X"
	Method              // "(*Buffer).Grow"
)

func (Kind) String

func (kind Kind) String() string

type Symbol

type Symbol struct {
	Name    string
	Kind    Kind
	Version Version // Go version that first included the symbol
}

func (*Symbol) SplitField

func (sym *Symbol) SplitField() (typename, name string)

SplitField splits the field symbol name into type and field components. It must be called only on Field symbols.

Example: "File.Package" -> ("File", "Package")

func (*Symbol) SplitMethod

func (sym *Symbol) SplitMethod() (ptr bool, recv, name string)

SplitMethod splits the method symbol name into pointer, receiver, and method components. It must be called only on Method symbols.

Example: "(*Buffer).Grow" -> (true, "Buffer", "Grow")

type Version

type Version int8

A Version represents a version of Go of the form "go1.%d".

func (Version) String

func (v Version) String() string

String returns a version string of the form "go1.23", without allocating.