api: audit for Go 1.18

[dmitshur]

This is a tracking issue for doing an audit of API additions for Go 1.18.
The list was populated from api/go1.18.txt including changes as of https://go.dev/cl/384154.

New API changes for Go 1.18

bufio

• pkg bufio, method (*Writer) AvailableBuffer() []uint8
• pkg bufio, method (ReadWriter) AvailableBuffer() []uint8

bytes

• pkg bytes, func Cut([]uint8, []uint8) ([]uint8, []uint8, bool)

crypto/tls

• pkg crypto/tls, method (*Conn) NetConn() net.Conn

debug/buildinfo

• pkg debug/buildinfo, func Read(io.ReaderAt) (*debug.BuildInfo, error)
• pkg debug/buildinfo, func ReadFile(string) (*debug.BuildInfo, error)
• pkg debug/buildinfo, type BuildInfo = debug.BuildInfo

debug/elf

• pkg debug/elf, const R_PPC64_RELATIVE = 22
• pkg debug/elf, const R_PPC64_RELATIVE R_PPC64

debug/dwarf

• pkg debug/dwarf, type BasicType struct, DataBitOffset int64
• pkg debug/dwarf, type StructField struct, DataBitOffset int64

debug/plan9obj

• pkg debug/plan9obj, var ErrNoSymbols error

go/ast

• pkg go/ast, method (*IndexListExpr) End() token.Pos
• pkg go/ast, method (*IndexListExpr) Pos() token.Pos
• pkg go/ast, type FuncType struct, TypeParams *FieldList
• pkg go/ast, type IndexListExpr struct
• pkg go/ast, type IndexListExpr struct, Indices []Expr
• pkg go/ast, type IndexListExpr struct, Lbrack token.Pos
• pkg go/ast, type IndexListExpr struct, Rbrack token.Pos
• pkg go/ast, type IndexListExpr struct, X Expr
• pkg go/ast, type TypeSpec struct, TypeParams *FieldList

go/constant

• pkg go/constant, method (Kind) String() string

go/token

• pkg go/token, const TILDE = 88
• pkg go/token, const TILDE Token

go/types

• pkg go/types, func Instantiate(*Context, Type, []Type, bool) (Type, error)
• pkg go/types, func NewContext() *Context
• pkg go/types, func NewSignatureType(*Var, []*TypeParam, []*TypeParam, *Tuple, *Tuple, bool) *Signature
• pkg go/types, func NewTerm(bool, Type) *Term
• pkg go/types, func NewTypeParam(*TypeName, Type) *TypeParam
• pkg go/types, func NewUnion([]*Term) *Union
• pkg go/types, method (*ArgumentError) Error() string
• pkg go/types, method (*ArgumentError) Unwrap() error
• pkg go/types, method (*Interface) IsComparable() bool
• pkg go/types, method (*Interface) IsImplicit() bool
• pkg go/types, method (*Interface) IsMethodSet() bool
• pkg go/types, method (*Interface) MarkImplicit()
• pkg go/types, method (*Named) Origin() *Named
• pkg go/types, method (*Named) SetTypeParams([]*TypeParam)
• pkg go/types, method (*Named) TypeArgs() *TypeList
• pkg go/types, method (*Named) TypeParams() *TypeParamList
• pkg go/types, method (*Signature) RecvTypeParams() *TypeParamList
• pkg go/types, method (*Signature) TypeParams() *TypeParamList
• pkg go/types, method (*Term) String() string
• pkg go/types, method (*Term) Tilde() bool
• pkg go/types, method (*Term) Type() Type
• pkg go/types, method (*TypeList) At(int) Type
• pkg go/types, method (*TypeList) Len() int
• pkg go/types, method (*TypeParam) Constraint() Type
• pkg go/types, method (*TypeParam) Index() int
• pkg go/types, method (*TypeParam) Obj() *TypeName
• pkg go/types, method (*TypeParam) SetConstraint(Type)
• pkg go/types, method (*TypeParam) String() string
• pkg go/types, method (*TypeParam) Underlying() Type
• pkg go/types, method (*TypeParamList) At(int) *TypeParam
• pkg go/types, method (*TypeParamList) Len() int
• pkg go/types, method (*Union) Len() int
• pkg go/types, method (*Union) String() string
• pkg go/types, method (*Union) Term(int) *Term
• pkg go/types, method (*Union) Underlying() Type
• pkg go/types, type ArgumentError struct
• pkg go/types, type ArgumentError struct, Err error
• pkg go/types, type ArgumentError struct, Index int
• pkg go/types, type Config struct, Context *Context
• pkg go/types, type Config struct, GoVersion string
• pkg go/types, type Context struct
• pkg go/types, type Info struct, Instances map[*ast.Ident]Instance
• pkg go/types, type Instance struct
• pkg go/types, type Instance struct, Type Type
• pkg go/types, type Instance struct, TypeArgs *TypeList
• pkg go/types, type Term struct
• pkg go/types, type TypeList struct
• pkg go/types, type TypeParam struct
• pkg go/types, type TypeParamList struct
• pkg go/types, type Union struct

net

• pkg net, func TCPAddrFromAddrPort(netip.AddrPort) *TCPAddr
• pkg net, func UDPAddrFromAddrPort(netip.AddrPort) *UDPAddr
• pkg net, method (*Resolver) LookupNetIP(context.Context, string, string) ([]netip.Addr, error)
• pkg net, method (*TCPAddr) AddrPort() netip.AddrPort
• pkg net, method (*UDPAddr) AddrPort() netip.AddrPort
• pkg net, method (*UDPConn) ReadFromUDPAddrPort([]uint8) (int, netip.AddrPort, error)
• pkg net, method (*UDPConn) ReadMsgUDPAddrPort([]uint8, []uint8) (int, int, int, netip.AddrPort, error)
• pkg net, method (*UDPConn) WriteMsgUDPAddrPort([]uint8, []uint8, netip.AddrPort) (int, int, error)
• pkg net, method (*UDPConn) WriteToUDPAddrPort([]uint8, netip.AddrPort) (int, error)

net/http

• pkg net/http, func MaxBytesHandler(Handler, int64) Handler
• pkg net/http, method (*Cookie) Valid() error

net/netip

• pkg net/netip, func AddrFrom16([16]uint8) Addr
• pkg net/netip, func AddrFrom4([4]uint8) Addr
• pkg net/netip, func AddrFromSlice([]uint8) (Addr, bool)
• pkg net/netip, func AddrPortFrom(Addr, uint16) AddrPort
• pkg net/netip, func IPv4Unspecified() Addr
• pkg net/netip, func IPv6LinkLocalAllNodes() Addr
• pkg net/netip, func IPv6Unspecified() Addr
• pkg net/netip, func MustParseAddr(string) Addr
• pkg net/netip, func MustParseAddrPort(string) AddrPort
• pkg net/netip, func MustParsePrefix(string) Prefix
• pkg net/netip, func ParseAddr(string) (Addr, error)
• pkg net/netip, func ParseAddrPort(string) (AddrPort, error)
• pkg net/netip, func ParsePrefix(string) (Prefix, error)
• pkg net/netip, func PrefixFrom(Addr, int) Prefix
• pkg net/netip, method (*Addr) UnmarshalBinary([]uint8) error
• pkg net/netip, method (*Addr) UnmarshalText([]uint8) error
• pkg net/netip, method (*AddrPort) UnmarshalBinary([]uint8) error
• pkg net/netip, method (*AddrPort) UnmarshalText([]uint8) error
• pkg net/netip, method (*Prefix) UnmarshalBinary([]uint8) error
• pkg net/netip, method (*Prefix) UnmarshalText([]uint8) error
• pkg net/netip, method (Addr) AppendTo([]uint8) []uint8
• pkg net/netip, method (Addr) As16() [16]uint8
• pkg net/netip, method (Addr) As4() [4]uint8
• pkg net/netip, method (Addr) AsSlice() []uint8
• pkg net/netip, method (Addr) BitLen() int
• pkg net/netip, method (Addr) Compare(Addr) int
• pkg net/netip, method (Addr) Is4() bool
• pkg net/netip, method (Addr) Is4In6() bool
• pkg net/netip, method (Addr) Is6() bool
• pkg net/netip, method (Addr) IsGlobalUnicast() bool
• pkg net/netip, method (Addr) IsInterfaceLocalMulticast() bool
• pkg net/netip, method (Addr) IsLinkLocalMulticast() bool
• pkg net/netip, method (Addr) IsLinkLocalUnicast() bool
• pkg net/netip, method (Addr) IsLoopback() bool
• pkg net/netip, method (Addr) IsMulticast() bool
• pkg net/netip, method (Addr) IsPrivate() bool
• pkg net/netip, method (Addr) IsUnspecified() bool
• pkg net/netip, method (Addr) IsValid() bool
• pkg net/netip, method (Addr) Less(Addr) bool
• pkg net/netip, method (Addr) MarshalBinary() ([]uint8, error)
• pkg net/netip, method (Addr) MarshalText() ([]uint8, error)
• pkg net/netip, method (Addr) Next() Addr
• pkg net/netip, method (Addr) Prefix(int) (Prefix, error)
• pkg net/netip, method (Addr) Prev() Addr
• pkg net/netip, method (Addr) String() string
• pkg net/netip, method (Addr) StringExpanded() string
• pkg net/netip, method (Addr) Unmap() Addr
• pkg net/netip, method (Addr) WithZone(string) Addr
• pkg net/netip, method (Addr) Zone() string
• pkg net/netip, method (AddrPort) Addr() Addr
• pkg net/netip, method (AddrPort) AppendTo([]uint8) []uint8
• pkg net/netip, method (AddrPort) IsValid() bool
• pkg net/netip, method (AddrPort) MarshalBinary() ([]uint8, error)
• pkg net/netip, method (AddrPort) MarshalText() ([]uint8, error)
• pkg net/netip, method (AddrPort) Port() uint16
• pkg net/netip, method (AddrPort) String() string
• pkg net/netip, method (Prefix) Addr() Addr
• pkg net/netip, method (Prefix) AppendTo([]uint8) []uint8
• pkg net/netip, method (Prefix) Bits() int
• pkg net/netip, method (Prefix) Contains(Addr) bool
• pkg net/netip, method (Prefix) IsSingleIP() bool
• pkg net/netip, method (Prefix) IsValid() bool
• pkg net/netip, method (Prefix) MarshalBinary() ([]uint8, error)
• pkg net/netip, method (Prefix) MarshalText() ([]uint8, error)
• pkg net/netip, method (Prefix) Masked() Prefix
• pkg net/netip, method (Prefix) Overlaps(Prefix) bool
• pkg net/netip, method (Prefix) String() string
• pkg net/netip, type Addr struct
• pkg net/netip, type AddrPort struct
• pkg net/netip, type Prefix struct

reflect

• pkg reflect, const Pointer = 22
• pkg reflect, const Pointer Kind
• pkg reflect, func PointerTo(Type) Type
• pkg reflect, method (*MapIter) Reset(Value)
• pkg reflect, method (Value) CanComplex() bool
• pkg reflect, method (Value) CanFloat() bool
• pkg reflect, method (Value) CanInt() bool
• pkg reflect, method (Value) CanUint() bool
• pkg reflect, method (Value) FieldByIndexErr([]int) (Value, error)
• pkg reflect, method (Value) SetIterKey(*MapIter)
• pkg reflect, method (Value) SetIterValue(*MapIter)
• pkg reflect, method (Value) UnsafePointer() unsafe.Pointer

runtime/debug

• pkg runtime/debug, func ParseBuildInfo(string) (*BuildInfo, error)
• pkg runtime/debug, method (*BuildInfo) String() string
• pkg runtime/debug, type BuildInfo struct, GoVersion string
• pkg runtime/debug, type BuildInfo struct, Settings []BuildSetting
• pkg runtime/debug, type BuildSetting struct
• pkg runtime/debug, type BuildSetting struct, Key string
• pkg runtime/debug, type BuildSetting struct, Value string

strings

• pkg strings, func Clone(string) string
• pkg strings, func Cut(string, string) (string, string, bool)

sync

• pkg sync, method (*Mutex) TryLock() bool
• pkg sync, method (*RWMutex) TryLock() bool
• pkg sync, method (*RWMutex) TryRLock() bool

syscall

• pkg syscall (freebsd-386), type SysProcAttr struct, Pdeathsig Signal
• pkg syscall (freebsd-386-cgo), type SysProcAttr struct, Pdeathsig Signal
• pkg syscall (freebsd-amd64), type SysProcAttr struct, Pdeathsig Signal
• pkg syscall (freebsd-amd64-cgo), type SysProcAttr struct, Pdeathsig Signal
• pkg syscall (freebsd-arm), type SysProcAttr struct, Pdeathsig Signal
• pkg syscall (freebsd-arm-cgo), type SysProcAttr struct, Pdeathsig Signal
• pkg syscall (windows-386), func SyscallN(uintptr, ...uintptr) (uintptr, uintptr, Errno)
• pkg syscall (windows-amd64), func SyscallN(uintptr, ...uintptr) (uintptr, uintptr, Errno)

testing

• pkg testing, func MainStart(testDeps, []InternalTest, []InternalBenchmark, []InternalFuzzTarget, []InternalExample) *M
• pkg testing, method (*F) Add(...interface{})
• pkg testing, method (*F) Cleanup(func())
• pkg testing, method (*F) Error(...interface{})
• pkg testing, method (*F) Errorf(string, ...interface{})
• pkg testing, method (*F) Fail()
• pkg testing, method (*F) FailNow()
• pkg testing, method (*F) Failed() bool
• pkg testing, method (*F) Fatal(...interface{})
• pkg testing, method (*F) Fatalf(string, ...interface{})
• pkg testing, method (*F) Fuzz(interface{})
• pkg testing, method (*F) Helper()
• pkg testing, method (*F) Log(...interface{})
• pkg testing, method (*F) Logf(string, ...interface{})
• pkg testing, method (*F) Name() string
• pkg testing, method (*F) Setenv(string, string)
• pkg testing, method (*F) Skip(...interface{})
• pkg testing, method (*F) SkipNow()
• pkg testing, method (*F) Skipf(string, ...interface{})
• pkg testing, method (*F) Skipped() bool
• pkg testing, method (*F) TempDir() string
• pkg testing, type F struct
• pkg testing, type InternalFuzzTarget struct
• pkg testing, type InternalFuzzTarget struct, Fn func(*F)
• pkg testing, type InternalFuzzTarget struct, Name string

text/template/parse

• pkg text/template/parse, const NodeBreak = 21
• pkg text/template/parse, const NodeBreak NodeType
• pkg text/template/parse, const NodeContinue = 22
• pkg text/template/parse, const NodeContinue NodeType
• pkg text/template/parse, method (*BreakNode) Copy() Node
• pkg text/template/parse, method (*BreakNode) String() string
• pkg text/template/parse, method (*ContinueNode) Copy() Node
• pkg text/template/parse, method (*ContinueNode) String() string
• pkg text/template/parse, method (BreakNode) Position() Pos
• pkg text/template/parse, method (BreakNode) Type() NodeType
• pkg text/template/parse, method (ContinueNode) Position() Pos
• pkg text/template/parse, method (ContinueNode) Type() NodeType
• pkg text/template/parse, type BreakNode struct
• pkg text/template/parse, type BreakNode struct, Line int
• pkg text/template/parse, type BreakNode struct, embedded NodeType
• pkg text/template/parse, type BreakNode struct, embedded Pos
• pkg text/template/parse, type ContinueNode struct
• pkg text/template/parse, type ContinueNode struct, Line int
• pkg text/template/parse, type ContinueNode struct, embedded NodeType
• pkg text/template/parse, type ContinueNode struct, embedded Pos

unicode/utf8

• pkg unicode/utf8, func AppendRune([]uint8, int32) []uint8

CC @rsc, @ianlancetaylor, @golang/release.

[ianlancetaylor]

• bufio: accepted proposal x/build/cmd/release: update to FreeBSD-[amd64|386]-11_4 builder for 1.17 Beta #45727
• bytes: accepted proposal bytes, strings: add Cut #46336
• crypto/tls: accepted proposal crypto/tls: allow access to net.Conn underneath tls.Conn #29257
• debug/buildinfo: accepted in cmd/go: factor version reading into debug/buildinfo #39301 and cmd/go: stamp git/vcs current HEAD hash/commit hash/dirty bit in binaries #37475; no formal proposal
• debug/elf: routine new constants, no proposal required
• debug/dwarf: routine update for debug/dwarf: resolve issues with new use of DW_AT_data_bit_offset #50685 and debug/dwarf: BitOffset values of bitfields is not being set in newer version of DWARF #46784, no proposal required
• debug/plan9obj: accepted proposal debug/plan9obj: add ErrNoSymbols sentinel for case that no symbol section exists #48052
• go/ast: updates for generics
• go/constant: accepted in go/constant: add Kind.String #46211; no formal proposal but it's fine
• go/token: updates for generics
• go/types: updates for generics (accepted proposal go/types: additions to support type parameters #47916)
• net: accepted proposal net/netip: add new IP address package, use in net #46518
• net/http: accepted proposals net/http: add MaxBytesHandler(h Handler, n int64) Handler #39567 and net/http: add Cookie.Valid method #46370
• net/netip: accepted proposal net/netip: add new IP address package, use in net #46518
• reflect: accepted proposals reflect: add Pointer #47651, reflect: add MapIter.Reset #46293, reflect: add Value.CanInt, CanUint, CanFloat #47658, reflect: add Value.FieldByIndexErr #48218, reflect: add MapIter.SetKey, SetValue, and friends #46131, reflect: rename MapIter.SetKey/SetValue -> Value.SetIterKey/SetIterValue #48294
• runtime/debug: accepted in cmd/go: factor version reading into debug/buildinfo #39301 and cmd/go: stamp git/vcs current HEAD hash/commit hash/dirty bit in binaries #37475; no formal proposal
• strings: accepted proposals bytes, strings: add Cut #46336 and bytes, strings: add Clone #45038
• sync: accepted proposal sync: add Mutex.TryLock #45435
• syscall: accepted proposals syscall: add Pdeathsig to SysProcAttr for FreeBSD #46258 and syscall: add SyscallN #46552
• testing: accepted proposal testing: add fuzz test support #44551
• text/template/parse: accepted proposal text/template: add break and continue support #20531
• unicode/utf8: accepted proposal unicode/utf8: add AppendRune #47609

[ianlancetaylor]

The only cases where a concern could be raised are the changes to debug/buildinfo, runtime/debug, and go/constant. All the rest either have officially affected proposals or clearly do not need them. To be clear, I think the changes to those three packages are fine.

[dmitshur]

Thank you Ian.

Russ, are you able to take a look at the remaining unchecked boxes?

[rsc]

constant.Kind.String is fine. I am amused that constant.String is a constant.Kind while constant.Kind.String is not.

[rsc]

debug/buildinfo and runtime/debug should have had a proposal.
It looks like I said otherwise in #39301 (comment) but that was when I thought it was going into x/mod. My mistake.

Bryan, Michael, Jay, and I did talk a lot about these APIs when they were being designed, though, so I think they have gotten sufficient attention. If I'd noticed this at the start of the freeze I'd have kicked them over to the release process for good measure, but at this point I'm not going to hold up all of Go 1.18. They're OK as is.

Apologies for the mistake and the deviation from standard process. We will endeavor to do better next time.

[rsc]

I believe that covers everything. Thanks Ian for checking the proposal issues. I wonder if going forward we should require the API file to have the proposal issue number at the end of the line. That would make this a lot easier for Go 1.19+.