The Go Programming Language Specification - The Go Programming Language
The Go Programming Language Specification - The Go Programming Language
Table of Contents
Introduction Calls
Notation Passing arguments to ... parameters
Source code representation Instantiations
Characters Type inference
Letters and digits Operators
Lexical elements Arithmetic operators
Comments Comparison operators
Tokens Logical operators
Semicolons Address operators
Identifiers Receive operator
Keywords Conversions
Operators and punctuation Constant expressions
Integer literals Order of evaluation
Floating-point literals Statements
Imaginary literals Terminating statements
Rune literals Empty statements
String literals Labeled statements
Constants Expression statements
Variables Send statements
Types IncDec statements
Boolean types Assignment statements
Numeric types If statements
String types Switch statements
Array types For statements
Slice types Go statements
Struct types Select statements
Pointer types Return statements
Function types Break statements
Interface types Continue statements
Map types Goto statements
Channel types Fallthrough statements
Properties of types and values Defer statements
Underlying types Built-in functions
Core types Appending to and copying slices
Type identity Clear
Assignability Close
Representability Manipulating complex numbers
Method sets Deletion of map elements
Blocks Length and capacity
Declarations and scope Making slices, maps and channels
Label scopes Min and max
Blank identifier Allocation
Predeclared identifiers Handling panics
https://go.dev/ref/spec#Tokens 1/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
Introduction
This is the reference manual for the Go programming language. The pre-Go1.18 version,
without generics, can be found here. For more information and other documents, see go.dev.
The syntax is compact and simple to parse, allowing for easy analysis by automatic tools such
as integrated development environments.
Notation
The syntax is specified using a variant of Extended Backus-Naur Form (EBNF):
Syntax = { Production } .
Production = production_name "=" [ Expression ] "." .
Expression = Term { "|" Term } .
Term = Factor { Factor } .
Factor = production_name | token [ "…" token ] | Group | Option | Repetition
Group = "(" Expression ")" .
Option = "[" Expression "]" .
Repetition = "{" Expression "}" .
https://go.dev/ref/spec#Tokens 2/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
Productions are expressions constructed from terms and the following operators, in increasing
precedence:
| alternation
() grouping
[] option (0 or 1 times)
{} repetition (0 to n times)
Lowercase production names are used to identify lexical (terminal) tokens. Non-terminals are
in CamelCase. Lexical tokens are enclosed in double quotes "" or back quotes ``.
The form a … b represents the set of characters from a through b as alternatives. The
horizontal ellipsis … is also used elsewhere in the spec to informally denote various
enumerations or code snippets that are not further specified. The character … (as opposed to
the three characters ...) is not a token of the Go language.
A link of the form [Go 1.xx] indicates that a described language feature (or some aspect of it)
was changed or added with language version 1.xx and thus requires at minimum that
language version to build. For details, see the linked section in the appendix.
Each code point is distinct; for instance, uppercase and lowercase letters are different
characters.
Implementation restriction: For compatibility with other tools, a compiler may disallow the NUL
character (U+0000) in the source text.
Implementation restriction: For compatibility with other tools, a compiler may ignore a UTF-8-
encoded byte order mark (U+FEFF) if it is the first Unicode code point in the source text. A
byte order mark may be disallowed anywhere else in the source.
Characters
The following terms are used to denote specific Unicode character categories:
In The Unicode Standard 8.0, Section 4.5 "General Category" defines a set of character
categories. Go treats all characters in any of the Letter categories Lu, Ll, Lt, Lm, or Lo as
Unicode letters, and those in the Number category Nd as Unicode digits.
https://go.dev/ref/spec#Tokens 3/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
Lexical elements
Comments
1. Line comments start with the character sequence // and stop at the end of the line.
2. General comments start with the character sequence /* and stop with the first
subsequent character sequence */.
A comment cannot start inside a rune or string literal, or inside a comment. A general comment
containing no newlines acts like a space. Any other comment acts like a newline.
Tokens
Tokens form the vocabulary of the Go language. There are four classes: identifiers, keywords,
operators and punctuation, and literals. White space, formed from spaces (U+0020), horizontal
tabs (U+0009), carriage returns (U+000D), and newlines (U+000A), is ignored except as it
separates tokens that would otherwise combine into a single token. Also, a newline or end of
file may trigger the insertion of a semicolon. While breaking the input into tokens, the next
token is the longest sequence of characters that form a valid token.
Semicolons
1. When the input is broken into tokens, a semicolon is automatically inserted into the token
stream immediately after a line's final token if that token is
an identifier
an integer, floating-point, imaginary, rune, or string literal
one of the keywords break, continue, fallthrough, or return
one of the operators and punctuation ++, --, ), ], or }
2. To allow complex statements to occupy a single line, a semicolon may be omitted before
a closing ")" or "}".
To reflect idiomatic use, code examples in this document elide semicolons using these rules.
https://go.dev/ref/spec#Tokens 4/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
Identifiers
Identifiers name program entities such as variables and types. An identifier is a sequence of
one or more letters and digits. The first character in an identifier must be a letter.
a
_x9
ThisVariableIsExported
αβ
Keywords
The following keywords are reserved and may not be used as identifiers.
The following character sequences represent operators (including assignment operators) and
punctuation [Go 1.18]:
Integer literals
For readability, an underscore character _ may appear after a base prefix or between
successive digits; such underscores do not change the literal's value.
https://go.dev/ref/spec#Tokens 5/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
hex_lit = "0" ( "x" | "X" ) [ "_" ] hex_digits .
42
4_2
0600
0_600
0o600
0O600 // second character is capital letter 'O'
0xBadFace
0xBad_Face
0x_67_7a_2f_cc_40_c6
170141183460469231731687303715884105727
170_141183_460469_231731_687303_715884_105727
Floating-point literals
A decimal floating-point literal consists of an integer part (decimal digits), a decimal point, a
fractional part (decimal digits), and an exponent part (e or E followed by an optional sign and
decimal digits). One of the integer part or the fractional part may be elided; one of the decimal
point or the exponent part may be elided. An exponent value exp scales the mantissa (integer
and fractional part) by 10exp.
For readability, an underscore character _ may appear after a base prefix or between
successive digits; such underscores do not change the literal value.
https://go.dev/ref/spec#Tokens 6/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
hex_float_lit = "0" ( "x" | "X" ) hex_mantissa hex_exponent .
hex_mantissa = [ "_" ] hex_digits "." [ hex_digits ] |
[ "_" ] hex_digits |
"." hex_digits .
hex exponent = ( "p" | "P" ) [ "+" | "-" ] decimal digits .
0.
72.40
072.40 // == 72.40
2.71828
1.e+0
6.67428e-11
1E6
.25
.12345E+5
1_5. // == 15.0
0.15e+0_2 // == 15.0
0x1p-2 // == 0.25
0x2.p10 // == 2048.0
0x1.Fp+0 // == 1.9375
0X.8p-0 // == 0.5
0X_1FFFP-16 // == 0.1249847412109375
0x15e-2 // == 0x15e - 2 (integer subtraction)
Imaginary literals
For backward compatibility, an imaginary literal's integer part consisting entirely of decimal
digits (and possibly underscores) is considered a decimal integer, even if it starts with a
leading 0.
0i
0123i // == 123i for backward-compatibility
0o123i // == 0o123 * 1i == 83i
0xabci // == 0xabc * 1i == 2748i
0.i
https://go.dev/ref/spec#Tokens 7/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
2.71828i
1.e+0i
6.67428e-11i
1E6i
.25i
.12345E+5i
0x1p-2i // == 0x1p-2 * 1i == 0.25i
Rune literals
A rune literal represents a rune constant, an integer value identifying a Unicode code point. A
rune literal is expressed as one or more characters enclosed in single quotes, as in 'x' or
'\n'. Within the quotes, any character may appear except newline and unescaped single
quote. A single quoted character represents the Unicode value of the character itself, while
multi-character sequences beginning with a backslash encode values in various formats.
The simplest form represents the single character within the quotes; since Go source text is
Unicode characters encoded in UTF-8, multiple UTF-8-encoded bytes may represent a single
integer value. For instance, the literal 'a' holds a single byte representing a literal a, Unicode
U+0061, value 0x61, while 'ä' holds two bytes (0xc3 0xa4) representing a literal a-dieresis,
U+00E4, value 0xe4.
Several backslash escapes allow arbitrary values to be encoded as ASCII text. There are four
ways to represent the integer value as a numeric constant: \x followed by exactly two
hexadecimal digits; \u followed by exactly four hexadecimal digits; \U followed by exactly
eight hexadecimal digits, and a plain backslash \ followed by exactly three octal digits. In each
case the value of the literal is the value represented by the digits in the corresponding base.
Although these representations all result in an integer, they have different valid ranges. Octal
escapes must represent a value between 0 and 255 inclusive. Hexadecimal escapes satisfy
this condition by construction. The escapes \u and \U represent Unicode code points so
within them some values are illegal, in particular those above 0x10FFFF and surrogate halves.
https://go.dev/ref/spec#Tokens 8/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
byte_value = octal_byte_value | hex_byte_value .
octal_byte_value = `\` octal_digit octal_digit octal_digit .
hex_byte_value = `\` "x" hex_digit hex_digit .
little_u_value = `\` "u" hex_digit hex_digit hex_digit hex_digit .
big_u_value = `\` "U" hex_digit hex_digit hex_digit hex_digit
hex_digit hex_digit hex_digit hex_digit .
escaped char = `\` ( "a" | "b" | "f" | "n" | "r" | "t" | "v" | `\` | "'" | `"
'a'
'ä'
'本'
'\t'
'\000'
'\007'
'\377'
'\x07'
'\xff'
'\u12e4'
'\U00101234'
'\'' // rune literal containing single quote character
'aa' // illegal: too many characters
'\k' // illegal: k is not recognized after a backslash
'\xa' // illegal: too few hexadecimal digits
'\0' // illegal: too few octal digits
'\400' // illegal: octal value over 255
'\uDFFF' // illegal: surrogate half
'\U00110000' // illegal: invalid Unicode code point
String literals
Raw string literals are character sequences between back quotes, as in `foo`. Within the
quotes, any character may appear except back quote. The value of a raw string literal is the
string composed of the uninterpreted (implicitly UTF-8-encoded) characters between the
quotes; in particular, backslashes have no special meaning and the string may contain
newlines. Carriage return characters ('\r') inside raw string literals are discarded from the raw
string value.
Interpreted string literals are character sequences between double quotes, as in "bar". Within
the quotes, any character may appear except newline and unescaped double quote. The text
between the quotes forms the value of the literal, with backslash escapes interpreted as they
are in rune literals (except that \' is illegal and \" is legal), with the same restrictions. The
three-digit octal (\nnn) and two-digit hexadecimal (\xnn) escapes represent individual bytes of
the resulting string; all other escapes represent the (possibly multi-byte) UTF-8 encoding of
individual characters. Thus inside a string literal \377 and \xFF represent a single byte of
value 0xFF=255, while ÿ, \u00FF, \U000000FF and \xc3\xbf represent the two bytes
0xc3 0xbf of the UTF-8 encoding of character U+00FF.
https://go.dev/ref/spec#Tokens 9/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
If the source code represents a character as two code points, such as a combining form
involving an accent and a letter, the result will be an error if placed in a rune literal (it is not a
single code point), and will appear as two code points if placed in a string literal.
Constants
There are boolean constants, rune constants, integer constants, floating-point constants,
complex constants, and string constants. Rune, integer, floating-point, and complex constants
are collectively called numeric constants.
In general, complex constants are a form of constant expression and are discussed in that
section.
Numeric constants represent exact values of arbitrary precision and do not overflow.
Consequently, there are no constants denoting the IEEE-754 negative zero, infinity, and not-a-
number values.
https://go.dev/ref/spec#Tokens 10/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
Constants may be typed or untyped. Literal constants, true, false, iota, and certain
constant expressions containing only untyped constant operands are untyped.
An untyped constant has a default type which is the type to which the constant is implicitly
converted in contexts where a typed value is required, for instance, in a short variable
declaration such as i := 0 where there is no explicit type. The default type of an untyped
constant is bool, rune, int, float64, complex128, or string respectively, depending on
whether it is a boolean, rune, integer, floating-point, complex, or string constant.
These requirements apply both to literal constants and to the result of evaluating constant
expressions.
Variables
A variable is a storage location for holding a value. The set of permissible values is determined
by the variable's type.
A variable declaration or, for function parameters and results, the signature of a function
declaration or function literal reserves storage for a named variable. Calling the built-in function
new or taking the address of a composite literal allocates storage for a variable at run time.
Such an anonymous variable is referred to via a (possibly implicit) pointer indirection.
Structured variables of array, slice, and struct types have elements and fields that may be
addressed individually. Each such element acts like a variable.
The static type (or just type) of a variable is the type given in its declaration, the type provided
in the new call or composite literal, or the type of an element of a structured variable. Variables
of interface type also have a distinct dynamic type, which is the (non-interface) type of the
value assigned to the variable at run time (unless the value is the predeclared identifier nil,
https://go.dev/ref/spec#Tokens 11/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
which has no type). The dynamic type may vary during execution but values stored in interface
variables are always assignable to the static type of the variable.
A variable's value is retrieved by referring to the variable in an expression; it is the most recent
value assigned to the variable. If a variable has not yet been assigned a value, its value is the
zero value for its type.
Types
A type determines a set of values together with operations and methods specific to those
values. A type may be denoted by a type name, if it has one, which must be followed by type
arguments if the type is generic. A type may also be specified using a type literal, which
composes a type from existing types.
The language predeclares certain type names. Others are introduced with type declarations or
type parameter lists. Composite types—array, struct, pointer, function, interface, slice, map,
and channel types—may be constructed using type literals.
Predeclared types, defined types, and type parameters are called named types. An alias
denotes a named type if the type given in the alias declaration is a named type.
Boolean types
A boolean type represents the set of Boolean truth values denoted by the predeclared
constants true and false. The predeclared boolean type is bool; it is a defined type.
Numeric types
https://go.dev/ref/spec#Tokens 12/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
int8 the set of all signed 8-bit integers (-128 to 127)
int16 the set of all signed 16-bit integers (-32768 to 32767)
int32 the set of all signed 32-bit integers (-2147483648 to 2147483647)
int64 the set of all signed 64-bit integers (-9223372036854775808 to 922337
complex64 the set of all complex numbers with float32 real and imaginary parts
complex128 the set of all complex numbers with float64 real and imaginary parts
The value of an n-bit integer is n bits wide and represented using two's complement arithmetic.
To avoid portability issues all numeric types are defined types and thus distinct except byte,
which is an alias for uint8, and rune, which is an alias for int32. Explicit conversions are
required when different numeric types are mixed in an expression or assignment. For instance,
int32 and int are not the same type even though they may have the same size on a
particular architecture.
String types
A string type represents the set of string values. A string value is a (possibly empty) sequence
of bytes. The number of bytes is called the length of the string and is never negative. Strings
are immutable: once created, it is impossible to change the contents of a string. The
predeclared string type is string; it is a defined type.
The length of a string s can be discovered using the built-in function len. The length is a
compile-time constant if the string is a constant. A string's bytes can be accessed by integer
indices 0 through len(s)-1. It is illegal to take the address of such an element; if s[i] is the
i'th byte of a string, &s[i] is invalid.
Array types
An array is a numbered sequence of elements of a single type, called the element type. The
number of elements is called the length of the array and is never negative.
https://go.dev/ref/spec#Tokens 13/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
The length is part of the array's type; it must evaluate to a non-negative constant representable
by a value of type int. The length of array a can be discovered using the built-in function len.
The elements can be addressed by integer indices 0 through len(a)-1. Array types are
always one-dimensional but may be composed to form multi-dimensional types.
[32]byte
[2*N] struct { x, y int32 }
[1000]*float64
[3][5]int
[2][2][2]float64 // same as [2]([2]([2]float64))
An array type T may not have an element of type T, or of a type containing T as a component,
directly or indirectly, if those containing types are only array or struct types.
Slice types
A slice is a descriptor for a contiguous segment of an underlying array and provides access to
a numbered sequence of elements from that array. A slice type denotes the set of all slices of
arrays of its element type. The number of elements is called the length of the slice and is never
negative. The value of an uninitialized slice is nil.
The length of a slice s can be discovered by the built-in function len; unlike with arrays it may
change during execution. The elements can be addressed by integer indices 0 through
len(s)-1. The slice index of a given element may be less than the index of the same
element in the underlying array.
A slice, once initialized, is always associated with an underlying array that holds its elements. A
slice therefore shares storage with its array and with other slices of the same array; by
contrast, distinct arrays always represent distinct storage.
The array underlying a slice may extend past the end of the slice. The capacity is a measure of
that extent: it is the sum of the length of the slice and the length of the array beyond the slice;
https://go.dev/ref/spec#Tokens 14/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
a slice of length up to that capacity can be created by slicing a new one from the original slice.
The capacity of a slice a can be discovered using the built-in function cap(a).
A new, initialized slice value for a given element type T may be made using the built-in function
make, which takes a slice type and parameters specifying the length and optionally the
capacity. A slice created with make always allocates a new, hidden array to which the returned
slice value refers. That is, executing
produces the same slice as allocating an array and slicing it, so these two expressions are
equivalent:
Like arrays, slices are always one-dimensional but may be composed to construct higher-
dimensional objects. With arrays of arrays, the inner arrays are, by construction, always the
same length; however with slices of slices (or arrays of slices), the inner lengths may vary
dynamically. Moreover, the inner slices must be initialized individually.
Struct types
A struct is a sequence of named elements, called fields, each of which has a name and a type.
Field names may be specified explicitly (IdentifierList) or implicitly (EmbeddedField). Within a
struct, non-blank field names must be unique.
// An empty struct.
struct {}
A field declared with a type but no explicit field name is called an embedded field. An
embedded field must be specified as a type name T or as a pointer to a non-interface type
name *T, and T itself may not be a pointer type. The unqualified type name acts as the field
name.
https://go.dev/ref/spec#Tokens 15/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
// A struct with four embedded fields of types T1, *T2, P.T3 and *P.T4
struct {
T1 // field name is T1
*T2 // field name is T2
P.T3 // field name is T3
*P.T4 // field name is T4
x, y int // field names are x and y
}
The following declaration is illegal because field names must be unique in a struct type:
struct {
T // conflicts with embedded field *T and *P.T
*T // conflicts with embedded field T and *P.T
*P.T // conflicts with embedded field T and *T
}
Promoted fields act like ordinary fields of a struct except that they cannot be used as field
names in composite literals of the struct.
Given a struct type S and a named type T, promoted methods are included in the method set
of the struct as follows:
If S contains an embedded field T, the method sets of S and *S both include promoted
methods with receiver T. The method set of *S also includes promoted methods with
receiver *T.
If S contains an embedded field *T, the method sets of S and *S both include promoted
methods with receiver T or *T.
A field declaration may be followed by an optional string literal tag, which becomes an attribute
for all the fields in the corresponding field declaration. An empty tag string is equivalent to an
absent tag. The tags are made visible through a reflection interface and take part in type
identity for structs but are otherwise ignored.
struct {
x, y float64 "" // an empty tag string is like an absent tag
name string "any string is permitted as a tag"
_ [4]byte "ceci n'est pas un champ de structure"
}
https://go.dev/ref/spec#Tokens 16/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
A struct type T may not contain a field of type T, or of a type containing T as a component,
directly or indirectly, if those containing types are only array or struct types.
Pointer types
A pointer type denotes the set of all pointers to variables of a given type, called the base type
of the pointer. The value of an uninitialized pointer is nil.
*Point
*[4]int
Function types
A function type denotes the set of all functions with the same parameter and result types. The
value of an uninitialized variable of function type is nil.
Within a list of parameters or results, the names (IdentifierList) must either all be present or all
be absent. If present, each name stands for one item (parameter or result) of the specified
type and all non-blank names in the signature must be unique. If absent, each type stands for
one item of that type. Parameter and result lists are always parenthesized except that if there
is exactly one unnamed result it may be written as an unparenthesized type.
The final incoming parameter in a function signature may have a type prefixed with .... A
function with such a parameter is called variadic and may be invoked with zero or more
https://go.dev/ref/spec#Tokens 17/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
func()
func(x int) int
func(a, _ int, z float32) bool
func(a, b int, z float32) (bool)
func(prefix string, values ...int)
func(a, b int, z float64, opt ...interface{}) (success bool)
func(int, int, float64) (float64, *[]int)
func(n int) func(p *T)
Interface types
An interface type defines a type set. A variable of interface type can store a value of any type
that is in the type set of the interface. Such a type is said to implement the interface. The value
of an uninitialized variable of interface type is nil.
Basic interfaces
In its most basic form an interface specifies a (possibly empty) list of methods. The type set
defined by such an interface is the set of types which implement all of those methods, and the
corresponding method set consists exactly of the methods specified by the interface.
Interfaces whose type sets can be defined entirely by a list of methods are called basic
interfaces.
The name of each explicitly specified method must be unique and not blank.
interface {
String() string
String() string // illegal: String not unique
_(x int) // illegal: method must have non-blank name
}
https://go.dev/ref/spec#Tokens 18/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
More than one type may implement an interface. For instance, if two types S1 and S2 have the
method set
(where T stands for either S1 or S2) then the File interface is implemented by both S1 and
S2, regardless of what other methods S1 and S2 may have or share.
Every type that is a member of the type set of an interface implements that interface. Any
given type may implement several distinct interfaces. For instance, all types implement the
empty interface which stands for the set of all (non-interface) types:
interface{}
For convenience, the predeclared type any is an alias for the empty interface. [Go 1.18]
Similarly, consider this interface specification, which appears within a type declaration to define
an interface called Locker:
func (p T) Lock() { … }
func (p T) Unlock() { … }
Embedded interfaces
In a slightly more general form an interface T may use a (possibly qualified) interface type
name E as an interface element. This is called embedding interface E in T [Go 1.14]. The type
set of T is the intersection of the type sets defined by T's explicitly declared methods and the
type sets of T’s embedded interfaces. In other words, the type set of T is the set of all types
that implement all the explicitly declared methods of T and also all the methods of E [Go 1.18].
https://go.dev/ref/spec#Tokens 19/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
}
When embedding interfaces, methods with the same names must have identical signatures.
General interfaces
In their most general form, an interface element may also be an arbitrary type term T, or a term
of the form ~T specifying the underlying type T, or a union of terms t1|t2|…|tn [Go 1.18].
Together with method specifications, these elements enable the precise definition of an
interface's type set as follows:
The type set of the empty interface is the set of all non-interface types.
The type set of a non-empty interface is the intersection of the type sets of its interface
elements.
The type set of a method specification is the set of all non-interface types whose method
sets include that method.
The type set of a non-interface type term is the set consisting of just that type.
The type set of a term of the form ~T is the set of all types whose underlying type is T.
The type set of a union of terms t1|t2|…|tn is the union of the type sets of the terms.
The quantification "the set of all non-interface types" refers not just to all (non-interface) types
declared in the program at hand, but all possible types in all possible programs, and hence is
infinite. Similarly, given the set of all non-interface types that implement a particular method,
the intersection of the method sets of those types will contain exactly that method, even if all
types in the program at hand always pair that method with another method.
// An interface representing all types with underlying type int that implement th
https://go.dev/ref/spec#Tokens 20/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
interface {
~int
String() string
}
In a term of the form ~T, the underlying type of T must be itself, and T cannot be an interface.
interface {
~[]byte // the underlying type of []byte is itself
~MyInt // illegal: the underlying type of MyInt is not MyInt
~error // illegal: error is an interface
}
The type T in a term of the form T or ~T cannot be a type parameter, and the type sets of all
non-interface terms must be pairwise disjoint (the pairwise intersection of the type sets must
be empty). Given a type parameter P:
interface {
P // illegal: P is a type parameter
int | ~P // illegal: P is a type parameter
~int | MyInt // illegal: the type sets for ~int and MyInt are not dis
float32 | Float // overlapping type sets but Float is an interface
}
Implementation restriction: A union (with more than one term) cannot contain the predeclared
identifier comparable or interfaces that specify methods, or embed comparable or
interfaces that specify methods.
Interfaces that are not basic may only be used as type constraints, or as elements of other
interfaces used as constraints. They cannot be the types of values or variables, or components
of other, non-interface types.
https://go.dev/ref/spec#Tokens 21/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
An interface type T may not embed a type element that is, contains, or embeds T, directly or
indirectly.
// illegal: Bad4 may not embed an array containing Bad4 as element type
type Bad4 interface {
[10]Bad4
}
Implementing an interface
Map types
A map is an unordered group of elements of one type, called the element type, indexed by a
set of unique keys of another type, called the key type. The value of an uninitialized map is
nil.
https://go.dev/ref/spec#Tokens 22/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
The comparison operators == and != must be fully defined for operands of the key type; thus
the key type must not be a function, map, or slice. If the key type is an interface type, these
comparison operators must be defined for the dynamic key values; failure will cause a run-time
panic.
map[string]int
map[*T]struct{ x, y float64 }
map[string]interface{}
The number of map elements is called its length. For a map m, it can be discovered using the
built-in function len and may change during execution. Elements may be added during
execution using assignments and retrieved with index expressions; they may be removed with
the delete and clear built-in function.
A new, empty map value is made using the built-in function make, which takes the map type
and an optional capacity hint as arguments:
make(map[string]int)
make(map[string]int, 100)
The initial capacity does not bound its size: maps grow to accommodate the number of items
stored in them, with the exception of nil maps. A nil map is equivalent to an empty map
except that no elements may be added.
Channel types
The optional <- operator specifies the channel direction, send or receive. If a direction is
given, the channel is directional, otherwise it is bidirectional. A channel may be constrained
only to send or only to receive by assignment or explicit conversion.
https://go.dev/ref/spec#Tokens 23/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
A new, initialized channel value can be made using the built-in function make, which takes the
channel type and an optional capacity as arguments:
The capacity, in number of elements, sets the size of the buffer in the channel. If the capacity
is zero or absent, the channel is unbuffered and communication succeeds only when both a
sender and receiver are ready. Otherwise, the channel is buffered and communication
succeeds without blocking if the buffer is not full (sends) or not empty (receives). A nil
channel is never ready for communication.
A channel may be closed with the built-in function close. The multi-valued assignment form of
the receive operator reports whether a received value was sent before the channel was
closed.
A single channel may be used in send statements, receive operations, and calls to the built-in
functions cap and len by any number of goroutines without further synchronization. Channels
act as first-in-first-out queues. For example, if one goroutine sends values on a channel and a
second goroutine receives them, the values are received in the order sent.
Each type T has an underlying type: If T is one of the predeclared boolean, numeric, or string
types, or a type literal, the corresponding underlying type is T itself. Otherwise, T's underlying
type is the underlying type of the type to which T refers in its declaration. For a type parameter
that is the underlying type of its type constraint, which is always an interface.
type (
A1 = string
A2 = A1
)
type (
B1 string
B2 B1
B3 []B1
B4 B3
)
The underlying type of string, A1, A2, B1, and B2 is string. The underlying type of []B1,
B3, and B4 is []B1. The underlying type of P is interface{}.
Core types
Each non-interface type T has a core type, which is the same as the underlying type of T.
https://go.dev/ref/spec#Tokens 24/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
1. There is a single type U which is the underlying type of all types in the type set of T; or
2. the type set of T contains only channel types with identical element type E, and all
directional channels have the same direction.
The core type of an interface is, depending on the condition that is satisfied, either:
1. the type U; or
2. the type chan E if T contains only bidirectional channels, or the type chan<- E or <-
chan E depending on the direction of the directional channels present.
By definition, a core type is never a defined type, type parameter, or interface type.
Some operations (slice expressions, append and copy) rely on a slightly more loose form of
core types which accept byte slices and strings. Specifically, if there are exactly two types,
[]byte and string, which are the underlying types of all types in the type set of interface T,
the core type of T is called bytestring.
Note that bytestring is not a real type; it cannot be used to declare variables or compose
other types. It exists solely to describe the behavior of some operations that read from a
sequence of bytes, which may be a byte slice or a string.
https://go.dev/ref/spec#Tokens 25/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
Type identity
A named type is always different from any other type. Otherwise, two types are identical if their
underlying type literals are structurally equivalent; that is, they have the same literal structure
and corresponding components have identical types. In detail:
Two array types are identical if they have identical element types and the same array
length.
Two slice types are identical if they have identical element types.
Two struct types are identical if they have the same sequence of fields, and if
corresponding fields have the same names, and identical types, and identical tags. Non-
exported field names from different packages are always different.
Two pointer types are identical if they have identical base types.
Two function types are identical if they have the same number of parameters and result
values, corresponding parameter and result types are identical, and either both functions
are variadic or neither is. Parameter and result names are not required to match.
Two interface types are identical if they define the same type set.
Two map types are identical if they have identical key and element types.
Two channel types are identical if they have identical element types and the same
direction.
Two instantiated types are identical if their defined types and all type arguments are
identical.
type (
A0 = []string
A1 = A0
A2 = struct{ a, b int }
A3 = int
A4 = func(A3, float64) *A0
A5 = func(x int, _ float64) *[]string
B0 A0
B1 []string
B2 struct{ a, b int }
B3 struct{ a, c int }
B4 func(int, float64) *B0
B5 func(x int, y float64) *A1
C0 = B0
D0[P1, P2 any] struct{ x P1; y P2 }
E0 = D0[int, string]
)
B0 and C0
D0[int, string] and E0
[]int and []int
struct{ a, b *B5 } and struct{ a, b *B5 }
func(x int, y float64) *[]string, func(int, float64) (result *[]string), and A5
B0 and B1 are different because they are new types created by distinct type definitions;
func(int, float64) *B0 and func(x int, y float64) *[]string are different
because B0 is different from []string; and P1 and P2 are different because they are
different type parameters. D0[int, string] and struct{ x int; y string } are different
because the former is an instantiated defined type while the latter is a type literal (but they are
still assignable).
Assignability
A value x of type V is assignable to a variable of type T ("x is assignable to T") if one of the
following conditions applies:
Additionally, if x's type V or T are type parameters, x is assignable to a variable of type T if one
of the following conditions applies:
Representability
simplified to an unsigned zero. Note that constant values never result in an IEEE
negative zero, NaN, or infinity.
T is a complex type, and x's components real(x) and imag(x) are representable by
values of T's component type (float32 or float64).
Method sets
The method set of a type determines the methods that can be called on an operand of that
type. Every type has a (possibly empty) method set associated with it:
The method set of a defined type T consists of all methods declared with receiver type T.
The method set of a pointer to a defined type T (where T is neither a pointer nor an
interface) is the set of all methods declared with receiver *T or T.
The method set of an interface type is the intersection of the method sets of each type in
the interface's type set (the resulting method set is usually just the set of declared
methods in the interface).
Further rules apply to structs (and pointer to structs) containing embedded fields, as described
in the section on struct types. Any other type has an empty method set.
In a method set, each method must have a unique non-blank method name.
Blocks
https://go.dev/ref/spec#Tokens 28/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
A block is a possibly empty sequence of declarations and statements within matching brace
brackets.
In addition to explicit blocks in the source code, there are implicit blocks:
The blank identifier may be used like any other identifier in a declaration, but it does not
introduce a binding and thus is not declared. In the package block, the identifier init may
only be used for init function declarations, and like the blank identifier it does not introduce a
new binding.
The scope of a declared identifier is the extent of source text in which the identifier denotes the
specified constant, type, variable, function, label, or package.
https://go.dev/ref/spec#Tokens 29/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
7. The scope of a constant or variable identifier declared inside a function begins at the end
of the ConstSpec or VarSpec (ShortVarDecl for short variable declarations) and ends at
the end of the innermost containing block.
8. The scope of a type identifier declared inside a function begins at the identifier in the
TypeSpec and ends at the end of the innermost containing block.
An identifier declared in a block may be redeclared in an inner block. While the identifier of the
inner declaration is in scope, it denotes the entity declared by the inner declaration.
The package clause is not a declaration; the package name does not appear in any scope. Its
purpose is to identify the files belonging to the same package and to specify the default
package name for import declarations.
Label scopes
Labels are declared by labeled statements and are used in the "break", "continue", and "goto"
statements. It is illegal to define a label that is never used. In contrast to other identifiers,
labels are not block scoped and do not conflict with identifiers that are not labels. The scope of
a label is the body of the function in which it is declared and excludes the body of any nested
function.
Blank identifier
Predeclared identifiers
The following identifiers are implicitly declared in the universe block [Go 1.18] [Go 1.21]:
Types:
any bool byte comparable
complex64 complex128 error float32 float64
int int8 int16 int32 int64 rune string
uint uint8 uint16 uint32 uint64 uintptr
Constants:
true false iota
Zero value:
nil
Functions:
append cap clear close complex copy delete imag len
make max min new panic print println real recover
Exported identifiers
1. the first character of the identifier's name is a Unicode uppercase letter (Unicode
character category Lu); and
2. the identifier is declared in the package block or it is a field name or method name.
Uniqueness of identifiers
Given a set of identifiers, an identifier is called unique if it is different from every other in the
set. Two identifiers are different if they are spelled differently, or if they appear in different
packages and are not exported. Otherwise, they are the same.
Constant declarations
A constant declaration binds a list of identifiers (the names of the constants) to the values of a
list of constant expressions. The number of identifiers must be equal to the number of
expressions, and the nth identifier on the left is bound to the value of the nth expression on the
right.
If the type is present, all constants take the type specified, and the expressions must be
assignable to that type, which must not be a type parameter. If the type is omitted, the
constants take the individual types of the corresponding expressions. If the expression values
are untyped constants, the declared constants remain untyped and the constant identifiers
denote the constant values. For instance, if the expression is a floating-point literal, the
constant identifier denotes a floating-point constant, even if the literal's fractional part is zero.
Within a parenthesized const declaration list the expression list may be omitted from any but
the first ConstSpec. Such an empty list is equivalent to the textual substitution of the first
preceding non-empty expression list and its type if any. Omitting the list of expressions is
therefore equivalent to repeating the previous list. The number of identifiers must be equal to
the number of expressions in the previous list. Together with the iota constant generator this
mechanism permits light-weight declaration of sequential values:
https://go.dev/ref/spec#Tokens 31/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
const (
Sunday = iota
Monday
Tuesday
Wednesday
Thursday
Friday
Partyday
numberOfDays // this constant is not exported
)
Iota
Within a constant declaration, the predeclared identifier iota represents successive untyped
integer constants. Its value is the index of the respective ConstSpec in that constant
declaration, starting at zero. It can be used to construct a set of related constants:
const (
c0 = iota // c0 == 0
c1 = iota // c1 == 1
c2 = iota // c2 == 2
)
const (
a = 1 << iota // a == 1 (iota == 0)
b = 1 << iota // b == 2 (iota == 1)
c = 3 // c == 3 (iota == 2, unused)
d = 1 << iota // d == 8 (iota == 3)
)
const (
u = iota * 42 // u == 0 (untyped integer constant)
v float64 = iota * 42 // v == 42.0 (float64 constant)
w = iota * 42 // w == 84 (untyped integer constant)
)
const x = iota // x == 0
const y = iota // y == 0
By definition, multiple uses of iota in the same ConstSpec all have the same value:
const (
bit0, mask0 = 1 << iota, 1<<iota - 1 // bit0 == 1, mask0 == 0 (iota ==
bit1, mask1 // bit1 == 2, mask1 == 1 (iota ==
_, _ // (iota ==
bit3, mask3 // bit3 == 8, mask3 == 7 (iota ==
)
This last example exploits the implicit repetition of the last non-empty expression list.
Type declarations
https://go.dev/ref/spec#Tokens 32/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
A type declaration binds an identifier, the type name, to a type. Type declarations come in two
forms: alias declarations and type definitions.
Alias declarations
Within the scope of the identifier, it serves as an alias for the type.
type (
nodeList = []*Node // nodeList and []*Node are identical types
Polar = polar // Polar and polar denote identical types
)
Type definitions
A type definition creates a new, distinct type with the same underlying type and operations as
the given type and binds an identifier, the type name, to it.
The new type is called a defined type. It is different from any other type, including the type it is
created from.
type (
Point struct{ x, y float64 } // Point and struct{ x, y float64 } are dif
polar Point // polar and Point denote different types
)
A defined type may have methods associated with it. It does not inherit any methods bound to
the given type, but the method set of an interface type or of elements of a composite type
remains unchanged:
https://go.dev/ref/spec#Tokens 33/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
// NewMutex has the same composition as Mutex but its method set is empty.
type NewMutex Mutex
// MyBlock is an interface type that has the same method set as Block.
type MyBlock Block
Type definitions may be used to define different boolean, numeric, or string types and
associate methods with them:
const (
EST TimeZone = -(5 + iota)
CST
MST
PST
)
If the type definition specifies type parameters, the type name denotes a generic type. Generic
types must be instantiated when they are used.
https://go.dev/ref/spec#Tokens 34/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
type L T // illegal: T is a type parameter declared by the enclosing fu
}
A generic type may also have methods associated with it. In this case, the method receivers
must declare the same number of type parameters as present in the generic type definition.
// The method Len returns the number of elements in the linked list l.
func (l *List[T]) Len() int { … }
A type parameter list declares the type parameters of a generic function or type declaration.
The type parameter list looks like an ordinary function parameter list except that the type
parameter names must all be present and the list is enclosed in square brackets rather than
parentheses [Go 1.18].
All non-blank names in the list must be unique. Each name declares a type parameter, which
is a new and different named type that acts as a placeholder for an (as of yet) unknown type in
the declaration. The type parameter is replaced with a type argument upon instantiation of the
generic function or type.
[P any]
[S interface{ ~[]byte|string }]
[S ~[]E, E any]
[P Constraint[int]]
[_ any]
Just as each ordinary function parameter has a parameter type, each type parameter has a
corresponding (meta-)type which is called its type constraint.
A parsing ambiguity arises when the type parameter list for a generic type declares a single
type parameter P with a constraint C such that the text P C forms a valid expression:
In these rare cases, the type parameter list is indistinguishable from an expression and the
type declaration is parsed as an array type declaration. To resolve the ambiguity, embed the
constraint in an interface or use a trailing comma:
https://go.dev/ref/spec#Tokens 35/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
Type parameters may also be declared by the receiver specification of a method declaration
associated with a generic type.
Within a type parameter list of a generic type T, a type constraint may not (directly, or indirectly
through the type parameter list of another generic type) refer to T.
type T6[P int] struct{ f *T6[P] } // ok: reference to T6 is not in type param
Type constraints
A type constraint is an interface that defines the set of permissible type arguments for the
respective type parameter and controls the operations supported by values of that type
parameter [Go 1.18].
TypeConstraint = TypeElem .
[T []P] // = [T interface{[]P}]
[T ~int] // = [T interface{~int}]
[T int|string] // = [T interface{int|string}]
type Constraint ~int // illegal: ~int is not in a type parameter list
The predeclared interface type comparable denotes the set of all non-interface types that are
strictly comparable [Go 1.18].
Even though interfaces that are not type parameters are comparable, they are not strictly
comparable and therefore they do not implement comparable. However, they satisfy
comparable.
The comparable interface and interfaces that (directly or indirectly) embed comparable may
only be used as type constraints. They cannot be the types of values or variables, or
https://go.dev/ref/spec#Tokens 36/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
A type argument T satisfies a type constraint C if T is an element of the type set defined by C;
i.e., if T implements C. As an exception, a strictly comparable type constraint may also be
satisfied by a comparable (not necessarily strictly comparable) type argument [Go 1.20]. More
precisely:
T implements C; or
C can be written in the form interface{ comparable; E }, where E is a basic
interface and T is comparable and implements E.
Because of the exception in the constraint satisfaction rule, comparing operands of type
parameter type may panic at run-time (even though comparable type parameters are always
strictly comparable).
Variable declarations
A variable declaration creates one or more variables, binds corresponding identifiers to them,
and gives each a type and an initial value.
var i int
var U, V, W float64
var k = 0
var x, y float32 = -1, -2
var (
i int
u, v, s = 2.0, 3.0, "bar"
)
var re, im = complexSqrt(-1)
var _, found = entries[name] // map lookup; only interested in "found"
https://go.dev/ref/spec#Tokens 37/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
If a list of expressions is given, the variables are initialized with the expressions following the
rules for assignment statements. Otherwise, each variable is initialized to its zero value.
If a type is present, each variable is given that type. Otherwise, each variable is given the type
of the corresponding initialization value in the assignment. If that value is an untyped constant,
it is first implicitly converted to its default type; if it is an untyped boolean value, it is first
implicitly converted to type bool. The predeclared value nil cannot be used to initialize a
variable with no explicit type.
Implementation restriction: A compiler may make it illegal to declare a variable inside a function
body if the variable is never used.
It is shorthand for a regular variable declaration with initializer expressions but no types:
i, j := 0, 10
f := func() int { return 7 }
ch := make(chan int)
r, w, _ := os.Pipe() // os.Pipe() returns a connected pair of Files and an error
_, y, _ := coord(p) // coord() returns three values; only interested in y coord
Unlike regular variable declarations, a short variable declaration may redeclare variables
provided they were originally declared earlier in the same block (or the parameter lists if the
block is the function body) with the same type, and at least one of the non-blank variables is
new. As a consequence, redeclaration can only appear in a multi-variable short declaration.
Redeclaration does not introduce a new variable; it just assigns a new value to the original.
The non-blank variable names on the left side of := must be unique.
Short variable declarations may appear only inside functions. In some contexts such as the
initializers for "if", "for", or "switch" statements, they can be used to declare local temporary
variables.
https://go.dev/ref/spec#Tokens 38/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
Function declarations
If the function's signature declares result parameters, the function body's statement list must
end in a terminating statement.
If the function declaration specifies type parameters, the function name denotes a generic
function. A generic function must be instantiated before it can be called or used as a value.
A function declaration without type parameters may omit the body. Such a declaration provides
the signature for a function implemented outside Go, such as an assembly routine.
Method declarations
A method is a function with a receiver. A method declaration binds an identifier, the method
name, to a method, and associates the method with the receiver's base type.
The receiver is specified via an extra parameter section preceding the method name. That
parameter section must declare a single non-variadic parameter, the receiver. Its type must be
a defined type T or a pointer to a defined type T, possibly followed by a list of type parameter
names [P1, P2, …] enclosed in square brackets. T is called the receiver base type. A
receiver base type cannot be a pointer or interface type and it must be defined in the same
https://go.dev/ref/spec#Tokens 39/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
package as the method. The method is said to be bound to its receiver base type and the
method name is visible only within selectors for type T or *T.
A non-blank receiver identifier must be unique in the method signature. If the receiver's value
is not referenced inside the body of the method, its identifier may be omitted in the declaration.
The same applies in general to parameters of functions and methods.
For a base type, the non-blank names of methods bound to it must be unique. If the base type
is a struct type, the non-blank method and field names must be distinct.
bind the methods Length and Scale, with receiver type *Point, to the base type Point.
If the receiver base type is a generic type, the receiver specification must declare
corresponding type parameters for the method to use. This makes the receiver type
parameters available to the method. Syntactically, this type parameter declaration looks like an
instantiation of the receiver base type: the type arguments must be identifiers denoting the
type parameters being declared, one for each type parameter of the receiver base type. The
type parameter names do not need to match their corresponding parameter names in the
receiver base type definition, and all non-blank parameter names must be unique in the
receiver parameter section and the method signature. The receiver type parameter constraints
are implied by the receiver base type definition: corresponding type parameters have
corresponding constraints.
Expressions
An expression specifies the computation of a value by applying operators and functions to
operands.
Operands
https://go.dev/ref/spec#Tokens 40/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
An operand name denoting a generic function may be followed by a list of type arguments; the
resulting operand is an instantiated function.
The blank identifier may appear as an operand only on the left-hand side of an assignment
statement.
Implementation restriction: A compiler need not report an error if an operand's type is a type
parameter with an empty type set. Functions with such type parameters cannot be
instantiated; any attempt will lead to an error at the instantiation site.
Qualified identifiers
A qualified identifier is an identifier qualified with a package name prefix. Both the package
name and the identifier must not be blank.
A qualified identifier accesses an identifier in a different package, which must be imported. The
identifier must be exported and declared in the package block of that package.
Composite literals
Composite literals construct new composite values each time they are evaluated. They consist
of the type of the literal followed by a brace-bound list of elements. Each element may
optionally be preceded by a corresponding key.
The LiteralType's core type T must be a struct, array, slice, or map type (the syntax enforces
this constraint except when the type is given as a TypeName). The types of the elements and
https://go.dev/ref/spec#Tokens 41/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
keys must be assignable to the respective field, element, and key types of type T; there is no
additional conversion. The key is interpreted as a field name for struct literals, an index for
array and slice literals, and a key for map literals. For map literals, all elements must have a
key. It is an error to specify multiple elements with the same field name or constant key value.
For non-constant map keys, see the section on evaluation order.
Each element has an associated integer index marking its position in the array.
An element with a key uses the key as its index. The key must be a non-negative
constant representable by a value of type int; and if it is typed it must be of integer type.
An element without a key uses the previous element's index plus one. If the first element
has no key, its index is zero.
Taking the address of a composite literal generates a pointer to a unique variable initialized
with the literal's value.
Note that the zero value for a slice or map type is not the same as an initialized but empty
value of the same type. Consequently, taking the address of an empty slice or map composite
literal does not have the same effect as allocating a new slice or map value with new.
https://go.dev/ref/spec#Tokens 42/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
The length of an array literal is the length specified in the literal type. If fewer elements than
the length are provided in the literal, the missing elements are set to the zero value for the
array element type. It is an error to provide elements with index values outside the index range
of the array. The notation ... specifies an array length equal to the maximum element index
plus one.
A slice literal describes the entire underlying array literal. Thus the length and capacity of a
slice literal are the maximum element index plus one. A slice literal has the form
Within a composite literal of array, slice, or map type T, elements or map keys that are
themselves composite literals may elide the respective literal type if it is identical to the
element or key type of T. Similarly, elements or keys that are addresses of composite literals
may elide the &T when the element or key type is *T.
A parsing ambiguity arises when a composite literal using the TypeName form of the
LiteralType appears as an operand between the keyword and the opening brace of the block of
an "if", "for", or "switch" statement, and the composite literal is not enclosed in parentheses,
square brackets, or curly braces. In this rare case, the opening brace of the literal is
erroneously parsed as the one introducing the block of statements. To resolve the ambiguity,
the composite literal must appear within parentheses.
if x == (T{a,b,c}[i]) { … }
if (x == T{a,b,c}[i]) { … }
https://go.dev/ref/spec#Tokens 43/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
Function literals
A function literal represents an anonymous function. Function literals cannot declare type
parameters.
Function literals are closures: they may refer to variables defined in a surrounding function.
Those variables are then shared between the surrounding function and the function literal, and
they survive as long as they are accessible.
Primary expressions
Primary expressions are the operands for unary and binary expressions.
PrimaryExpr =
Operand |
Conversion |
MethodExpr |
PrimaryExpr Selector |
PrimaryExpr Index |
PrimaryExpr Slice |
PrimaryExpr TypeAssertion |
PrimaryExpr Arguments .
x
2
(s + ".txt")
f(3.1415, true)
Point{1, 2}
m["foo"]
s[i : j + 1]
obj.color
f.p[i].x()
Selectors
For a primary expression x that is not a package name, the selector expression
x.f
denotes the field or method f of the value x (or sometimes *x; see below). The identifier f is
called the (field or method) selector; it must not be the blank identifier. The type of the selector
expression is the type of f. If x is a package name, see the section on qualified identifiers.
A selector f may denote a field or method f of a type T, or it may refer to a field or method f of
a nested embedded field of T. The number of embedded fields traversed to reach f is called
its depth in T. The depth of a field or method f declared in T is zero. The depth of a field or
method f declared in an embedded field A in T is the depth of f in A plus one.
1. For a value x of type T or *T where T is not a pointer or interface type, x.f denotes the
field or method at the shallowest depth in T where there is such an f. If there is not
exactly one f with shallowest depth, the selector expression is illegal.
2. For a value x of type I where I is an interface type, x.f denotes the actual method with
name f of the dynamic value of x. If there is no method with name f in the method set of
I, the selector expression is illegal.
3. As an exception, if the type of x is a defined pointer type and (*x).f is a valid selector
expression denoting a field (but not a method), x.f is shorthand for (*x).f.
4. In all other cases, x.f is illegal.
5. If x is of pointer type and has the value nil and x.f denotes a struct field, assigning to
or evaluating x.f causes a run-time panic.
6. If x is of interface type and has the value nil, calling or evaluating the method x.f
causes a run-time panic.
type T0 struct {
x int
}
https://go.dev/ref/spec#Tokens 45/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
type T1 struct {
y int
}
type T2 struct {
z int
T1
*T0
}
type Q *T2
t.z // t.z
t.y // t.T1.y
t.x // (*t.T0).x
p.z // (*p).z
p.y // (*p).T1.y
p.x // (*(*p).T0).x
Method expressions
If M is in the method set of type T, T.M is a function that is callable as a regular function with
the same arguments as M prefixed by an additional argument that is the receiver of the
method.
https://go.dev/ref/spec#Tokens 46/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
Consider a struct type T with two methods, Mv, whose receiver is of type T, and Mp, whose
receiver is of type *T.
type T struct {
a int
}
func (tv T) Mv(a int) int { return 0 } // value receiver
func (tp *T) Mp(f float32) float32 { return 1 } // pointer receiver
var t T
The expression
T.Mv
yields a function equivalent to Mv but with an explicit receiver as its first argument; it has
signature
That function may be called normally with an explicit receiver, so these five invocations are
equivalent:
t.Mv(7)
T.Mv(t, 7)
(T).Mv(t, 7)
f1 := T.Mv; f1(t, 7)
f2 := (T).Mv; f2(t, 7)
(*T).Mp
For a method with a value receiver, one can derive a function with an explicit pointer receiver,
so
(*T).Mv
Such a function indirects through the receiver to create a value to pass as the receiver to the
underlying method; the method does not overwrite the value whose address is passed in the
https://go.dev/ref/spec#Tokens 47/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
function call.
The final case, a value-receiver function for a pointer-receiver method, is illegal because
pointer-receiver methods are not in the method set of the value type.
Function values derived from methods are called with function call syntax; the receiver is
provided as the first argument to the call. That is, given f := T.Mv, f is invoked as f(t, 7)
not t.f(7). To construct a function that binds the receiver, use a function literal or method
value.
It is legal to derive a function value from a method of an interface type. The resulting function
takes an explicit receiver of that interface type.
Method values
If the expression x has static type T and M is in the method set of type T, x.M is called a
method value. The method value x.M is a function value that is callable with the same
arguments as a method call of x.M. The expression x is evaluated and saved during the
evaluation of the method value; the saved copy is then used as the receiver in any calls, which
may be executed later.
type S struct { *T }
type T int
func (t T) M() { print(t) }
t := new(T)
s := S{T: t}
f := t.M // receiver *t is evaluated and stored in f
g := s.M // receiver *(s.T) is evaluated and stored in g
*t = 42 // does not affect stored receivers in f and g
As in the discussion of method expressions above, consider a struct type T with two methods,
Mv, whose receiver is of type T, and Mp, whose receiver is of type *T.
type T struct {
a int
}
func (tv T) Mv(a int) int { return 0 } // value receiver
func (tp *T) Mp(f float32) float32 { return 1 } // pointer receiver
var t T
var pt *T
func makeT() T
The expression
t.Mv
https://go.dev/ref/spec#Tokens 48/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
func(int) int
t.Mv(7)
f := t.Mv; f(7)
pt.Mp
func(float32) float32
As with selectors, a reference to a non-interface method with a value receiver using a pointer
will automatically dereference that pointer: pt.Mv is equivalent to (*pt).Mv.
As with method calls, a reference to a non-interface method with a pointer receiver using an
addressable value will automatically take the address of that value: t.Mp is equivalent to
(&t).Mp.
Although the examples above use non-interface types, it is also legal to create a method value
from a value of interface type.
Index expressions
a[x]
denotes the element of the array, pointer to array, slice, string or map a indexed by x. The
value x is called the index or map key, respectively. The following rules apply:
the index x must be an untyped constant or its core type must be an integer
https://go.dev/ref/spec#Tokens 49/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
The index expression a[x] must be valid for values of all types in P's type set.
The element types of all types in P's type set must be identical. In this context, the
element type of a string type is byte.
If there is a map type in the type set of P, all types in that type set must be map types,
and the respective key types must be all identical.
a[x] is the array, slice, or string element at index x, or the map element with key x of
the type argument that P is instantiated with, and the type of a[x] is the type of the
(identical) element types.
a[x] may not be assigned to if P's type set includes string types.
https://go.dev/ref/spec#Tokens 50/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
v, ok = a[x]
v, ok := a[x]
var v, ok = a[x]
yields an additional untyped boolean value. The value of ok is true if the key x is present in
the map, and false otherwise.
Slice expressions
Slice expressions construct a substring or slice from a string, array, pointer to array, or slice.
There are two variants: a simple form that specifies a low and high bound, and a full form that
also specifies a bound on the capacity.
a[low : high]
constructs a substring or slice. The core type of a must be a string, array, pointer to array,
slice, or a bytestring. The indices low and high select which elements of operand a
appear in the result. The result has indices starting at 0 and length equal to high - low. After
slicing the array a
a := [5]int{1, 2, 3, 4, 5}
s := a[1:4]
s[0] == 2
s[1] == 3
s[2] == 4
For convenience, any of the indices may be omitted. A missing low index defaults to zero; a
missing high index defaults to the length of the sliced operand:
For arrays or strings, the indices are in range if 0 <= low <= high <= len(a), otherwise they
are out of range. For slices, the upper index bound is the slice capacity cap(a) rather than
https://go.dev/ref/spec#Tokens 51/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
the length. A constant index must be non-negative and representable by a value of type int;
for arrays or constant strings, constant indices must also be in range. If both indices are
constant, they must satisfy low <= high. If the indices are out of range at run time, a run-time
panic occurs.
Except for untyped strings, if the sliced operand is a string or slice, the result of the slice
operation is a non-constant value of the same type as the operand. For untyped string
operands the result is a non-constant value of type string. If the sliced operand is an array, it
must be addressable and the result of the slice operation is a slice with the same element type
as the array.
If the sliced operand of a valid slice expression is a nil slice, the result is a nil slice.
Otherwise, if the result is a slice, it shares its underlying array with the operand.
var a [10]int
s1 := a[3:7] // underlying array of s1 is array a; &s1[2] == &a[5]
s2 := s1[1:4] // underlying array of s2 is underlying array of s1 which is array
s2[1] = 42 // s2[1] == s1[2] == a[5] == 42; they all refer to the same underl
var s []int
s3 := s[:0] // s3 == nil
constructs a slice of the same type, and with the same length and elements as the simple slice
expression a[low : high]. Additionally, it controls the resulting slice's capacity by setting it to
max - low. Only the first index may be omitted; it defaults to 0. The core type of a must be an
array, pointer to array, or slice (but not a string). After slicing the array a
a := [5]int{1, 2, 3, 4, 5}
t := a[1:3:5]
t[0] == 2
t[1] == 3
The indices are in range if 0 <= low <= high <= max <= cap(a), otherwise they are out of
range. A constant index must be non-negative and representable by a value of type int; for
arrays, constant indices must also be in range. If multiple indices are constant, the constants
https://go.dev/ref/spec#Tokens 52/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
that are present must be in range relative to each other. If the indices are out of range at run
time, a run-time panic occurs.
Type assertions
For an expression x of interface type, but not a type parameter, and a type T, the primary
expression
x.(T)
asserts that x is not nil and that the value stored in x is of type T. The notation x.(T) is
called a type assertion.
More precisely, if T is not an interface type, x.(T) asserts that the dynamic type of x is
identical to the type T. In this case, T must implement the (interface) type of x; otherwise the
type assertion is invalid since it is not possible for x to store a value of type T. If T is an
interface type, x.(T) asserts that the dynamic type of x implements the interface T.
If the type assertion holds, the value of the expression is the value stored in x and its type is T.
If the type assertion is false, a run-time panic occurs. In other words, even though the dynamic
type of x is known only at run time, the type of x.(T) is known to be T in a correct program.
func f(y I) {
s := y.(string) // illegal: string does not implement I (missing m
r := y.(io.Reader) // r has type io.Reader and the dynamic type of y
…
}
v, ok = x.(T)
v, ok := x.(T)
var v, ok = x.(T)
var v, ok interface{} = x.(T) // dynamic types of v and ok are T and bool
yields an additional untyped boolean value. The value of ok is true if the assertion holds.
Otherwise it is false and the value of v is the zero value for type T. No run-time panic occurs
in this case.
Calls
https://go.dev/ref/spec#Tokens 53/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
calls f with arguments a1, a2, … an. Except for one special case, arguments must be single-
valued expressions assignable to the parameter types of F and are evaluated before the
function is called. The type of the expression is the result type of F. A method invocation is
similar but the method itself is specified as a selector upon a value of the receiver type for the
method.
In a function call, the function value and arguments are evaluated in the usual order. After they
are evaluated, the parameters of the call are passed by value to the function and the called
function begins execution. The return parameters of the function are passed by value back to
the caller when the function returns.
As a special case, if the return values of a function or method g are equal in number and
individually assignable to the parameters of another function or method f, then the call
f(g(parameters_of_g)) will invoke f after binding the return values of g to the parameters
of f in order. The call of f must contain no parameters other than the call of g, and g must
have at least one return value. If f has a final ... parameter, it is assigned the return values
of g that remain after assignment of regular parameters.
A method call x.m() is valid if the method set of (the type of) x contains m and the argument
list can be assigned to the parameter list of m. If x is addressable and &x's method set
contains m, x.m() is shorthand for (&x).m():
var p Point
p.Scale(3.5)
If f is variadic with a final parameter p of type ...T, then within f the type of p is equivalent to
type []T. If f is invoked with no actual arguments for p, the value passed to p is nil.
Otherwise, the value passed is a new slice of type []T with a new underlying array whose
successive elements are the actual arguments, which all must be assignable to T. The length
and capacity of the slice is therefore the number of arguments bound to p and may differ for
each call site.
within Greeting, who will have the value nil in the first call, and []string{"Joe",
"Anna", "Eileen"} in the second.
If the final argument is assignable to a slice type []T and is followed by ..., it is passed
unchanged as the value for a ...T parameter. In this case no new slice is created.
s := []string{"James", "Jasmine"}
Greeting("goodbye:", s...)
within Greeting, who will have the same value as s with the same underlying array.
Instantiations
A generic function or type is instantiated by substituting type arguments for the type
parameters [Go 1.18]. Instantiation proceeds in two steps:
1. Each type argument is substituted for its corresponding type parameter in the generic
declaration. This substitution happens across the entire function or type declaration,
including the type parameter list itself and any types in that list.
2. After substitution, each type argument must satisfy the constraint (instantiated, if
necessary) of the corresponding type parameter. Otherwise instantiation fails.
Instantiating a type results in a new non-generic named type; instantiating a function produces
a new non-generic function.
https://go.dev/ref/spec#Tokens 55/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
When using a generic function, type arguments may be provided explicitly, or they may be
partially or completely inferred from the context in which the function is used. Provided that
they can be inferred, type argument lists may be omitted entirely if the function is:
In all other cases, a (possibly partial) type argument list must be present. If a type argument
list is absent or partial, all missing type arguments must be inferrable from the context in which
the function is used.
A partial type argument list cannot be empty; at least the first argument must be present. The
list is a prefix of the full list of type arguments, leaving the remaining arguments to be inferred.
Loosely speaking, type arguments may be omitted from "right to left".
For a generic type, all type arguments must always be provided explicitly.
Type inference
A use of a generic function may omit some or all type arguments if they can be inferred from
the context within which the function is used, including the constraints of the function's type
parameters. Type inference succeeds if it can infer the missing type arguments and
instantiation succeeds with the inferred type arguments. Otherwise, type inference fails and
the program is invalid.
https://go.dev/ref/spec#Tokens 56/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
Type inference uses the type relationships between pairs of types for inference: For instance,
a function argument must be assignable to its respective function parameter; this establishes a
relationship between the type of the argument and the type of the parameter. If either of these
two types contains type parameters, type inference looks for the type arguments to substitute
the type parameters with such that the assignability relationship is satisfied. Similarly, type
inference uses the fact that a type argument must satisfy the constraint of its respective type
parameter.
Each such pair of matched types corresponds to a type equation containing one or multiple
type parameters, from one or possibly multiple generic functions. Inferring the missing type
arguments means solving the resulting set of type equations for the respective type
parameters.
// dedup returns a copy of the argument slice with any duplicate entries removed.
func dedup[S ~[]E, E comparable](S) S { … }
the variable s of type Slice must be assignable to the function parameter type S for the
program to be valid. To reduce complexity, type inference ignores the directionality of
assignments, so the type relationship between Slice and S can be expressed via the
(symmetric) type equation Slice ≡A S (or S ≡A Slice for that matter), where the A in ≡A
indicates that the LHS and RHS types must match per assignability rules (see the section on
type unification for details). Similarly, the type parameter S must satisfy its constraint ~[]E.
This can be expressed as S ≡C ~[]E where X ≡C Y stands for "X satisfies constraint Y". These
observations lead to a set of two equations
Slice ≡A S (1)
S ≡C ~[]E (2)
which now can be solved for the type parameters S and E. From (1) a compiler can infer that
the type argument for S is Slice. Similarly, because the underlying type of Slice is []int
and []int must match []E of the constraint, a compiler can infer that E must be int. Thus,
for these two equations, type inference infers
S ➞ Slice
E ➞ int
Given a set of type equations, the type parameters to solve for are the type parameters of the
functions that need to be instantiated and for which no explicit type arguments is provided.
These type parameters are called bound type parameters. For instance, in the dedup example
above, the type parameters S and E are bound to dedup. An argument to a generic function
https://go.dev/ref/spec#Tokens 57/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
call may be a generic function itself. The type parameters of that function are included in the
set of bound type parameters. The types of function arguments may contain type parameters
from other functions (such as a generic function enclosing a function call). Those type
parameters may also appear in type equations but they are not bound in that context. Type
equations are always solved for the bound type parameters only.
Type inference supports calls of generic functions and assignments of generic functions to
(explicitly function-typed) variables. This includes passing generic functions as arguments to
other (possibly also generic) functions, and returning generic functions as results. Type
inference operates on a set of equations specific to each of these cases. The equations are as
follows (type argument lists are omitted for clarity):
Additionally, each type parameter Pk and corresponding type constraint Ck yields the type
equation Pk ≡C Ck.
Type inference gives precedence to type information obtained from typed operands before
considering untyped constants. Therefore, inference proceeds in two phases:
1. The type equations are solved for the bound type parameters using type unification. If
unification fails, type inference fails.
2. For each bound type parameter Pk for which no type argument has been inferred yet and
for which one or more pairs (cj, Pk) with that same type parameter were collected,
determine the constant kind of the constants cj in all those pairs the same way as for
constant expressions. The type argument for Pk is the default type for the determined
constant kind. If a constant kind cannot be determined due to conflicting constant kinds,
type inference fails.
If not all type arguments have been found after these two phases, type inference fails.
https://go.dev/ref/spec#Tokens 58/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
If the two phases are successful, type inference determined a type argument for each bound
type parameter:
Pk ➞ Ak
A type argument Ak may be a composite type, containing other bound type parameters Pk as
element types (or even be just another bound type parameter). In a process of repeated
simplification, the bound type parameters in each type argument are substituted with the
respective type arguments for those type parameters until each type argument is free of bound
type parameters.
If type arguments contain cyclic references to themselves through bound type parameters,
simplification and thus type inference fails. Otherwise, type inference succeeds.
Type unification
Type inference solves type equations through type unification. Type unification recursively
compares the LHS and RHS types of an equation, where either or both types may be or
contain bound type parameters, and looks for type arguments for those type parameters such
that the LHS and RHS match (become identical or assignment-compatible, depending on
context). To that effect, type inference maintains a map of bound type parameters to inferred
type arguments; this map is consulted and updated during type unification. Initially, the bound
type parameters are known but the map is empty. During type unification, if a new type
argument A is inferred, the respective mapping P ➞ A from type parameter to argument is
added to the map. Conversely, when comparing types, a known type argument (a type
argument for which a map entry already exists) takes the place of its corresponding type
parameter. As type inference progresses, the map is populated more and more until all
equations have been considered, or until unification fails. Type inference succeeds if no
unification step fails and the map has an entry for each type parameter.
For example, given the type equation with the bound type parameter P
type inference starts with an empty map. Unification first compares the top-level structure of
the LHS and RHS types. Both are arrays of the same length; they unify if the element types
unify. Both element types are structs; they unify if they have the same number of fields with the
same names and if the field types unify. The type argument for P is not known yet (there is no
map entry), so unifying P with string adds the mapping P ➞ string to the map. Unifying the
types of the list field requires unifying []P and []string and thus P and string. Since
the type argument for P is known at this point (there is a map entry for P), its type argument
string takes the place of P. And since string is identical to string, this unification step
succeeds as well. Unification of the LHS and RHS of the equation is now finished. Type
inference succeeds because there is only one type equation, no unification step failed, and the
map is fully populated.
https://go.dev/ref/spec#Tokens 59/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
Unification uses a combination of exact and loose unification depending on whether two types
have to be identical, assignment-compatible, or only structurally equal. The respective type
unification rules are spelled out in detail in the Appendix.
For an equation of the form X ≡A Y, where X and Y are types involved in an assignment
(including parameter passing and return statements), the top-level type structures may unify
loosely but element types must unify exactly, matching the rules for assignments.
For an equation of the form P ≡C C, where P is a type parameter and C its corresponding
constraint, the unification rules are bit more complicated:
If C has a core type core(C) and P has a known type argument A, core(C) and A must
unify loosely. If P does not have a known type argument and C contains exactly one type
term T that is not an underlying (tilde) type, unification adds the mapping P ➞ T to the
map.
If C does not have a core type and P has a known type argument A, A must have all
methods of C, if any, and corresponding method types must unify exactly.
When solving type equations from type constraints, solving one equation may infer additional
type arguments, which in turn may enable solving other equations that depend on those type
arguments. Type inference repeats type unification as long as new type arguments are
inferred.
Operators
Comparisons are discussed elsewhere. For other binary operators, the operand types must be
identical unless the operation involves shifts or untyped constants. For operations involving
constants only, see the section on constant expressions.
Except for shift operations, if one operand is an untyped constant and the other operand is not,
the constant is implicitly converted to the type of the other operand.
The right operand in a shift expression must have integer type [Go 1.13] or be an untyped
constant representable by a value of type uint. If the left operand of a non-constant shift
expression is an untyped constant, it is first implicitly converted to the type it would assume if
the shift expression were replaced by its left operand alone.
https://go.dev/ref/spec#Tokens 60/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
var a [1024]byte
var s uint = 33
// The results of the following examples are given for 64-bit ints.
var i = 1<<s // 1 has type int
var j int32 = 1<<s // 1 has type int32; j == 0
var k = uint64(1<<s) // 1 has type uint64; k == 1<<33
var m int = 1.0<<s // 1.0 has type int; m == 1<<33
var n = 1.0<<s == j // 1.0 has type int32; n == true
var o = 1<<s == 2<<s // 1 and 2 have type int; o == false
var p = 1<<s == 1<<33 // 1 has type int; p == true
var u = 1.0<<s // illegal: 1.0 has type float64, cannot shift
var u1 = 1.0<<s != 0 // illegal: 1.0 has type float64, cannot shift
var u2 = 1<<s != 1.0 // illegal: 1 has type float64, cannot shift
var v1 float32 = 1<<s // illegal: 1 has type float32, cannot shift
var v2 = string(1<<s) // illegal: 1 is converted to a string, cannot shi
var w int64 = 1.0<<33 // 1.0<<33 is a constant shift expression; w == 1<
var x = a[1.0<<s] // panics: 1.0 has type int, but 1<<33 overflows a
var b = make([]byte, 1.0<<s) // 1.0 has type int; len(b) == 1<<33
// The results of the following examples are given for 32-bit ints,
// which means the shifts will overflow.
var mm int = 1.0<<s // 1.0 has type int; mm == 0
var oo = 1<<s == 2<<s // 1 and 2 have type int; oo == true
var pp = 1<<s == 1<<33 // illegal: 1 has type int, but 1<<33 overflows in
var xx = a[1.0<<s] // 1.0 has type int; xx == a[0]
var bb = make([]byte, 1.0<<s) // 1.0 has type int; len(bb) == 0
Operator precedence
Unary operators have the highest precedence. As the ++ and -- operators form statements,
not expressions, they fall outside the operator hierarchy. As a consequence, statement *p++ is
the same as (*p)++.
There are five precedence levels for binary operators. Multiplication operators bind strongest,
followed by addition operators, comparison operators, && (logical AND), and finally || (logical
OR):
Precedence Operator
5 * / % << >> & &^
4 + - | ^
3 == != < <= > >=
2 &&
1 ||
Binary operators of the same precedence associate from left to right. For instance, x / y * z is
the same as (x / y) * z.
+x // x
42 + a - b // (42 + a) - b
23 + 3*x[i] // 23 + (3 * x[i])
x <= f() // x <= f()
https://go.dev/ref/spec#Tokens 61/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
^a >> b // (^a) >> b
f() || g() // f() || g()
x == y+1 && <-chanInt > 0 // (x == (y+1)) && ((<-chanInt) > 0)
Arithmetic operators
Arithmetic operators apply to numeric values and yield a result of the same type as the first
operand. The four standard arithmetic operators (+, -, *, /) apply to integer, floating-point, and
complex types; + also applies to strings. The bitwise logical and shift operators apply to
integers only.
If the operand type is a type parameter, the operator must apply to each type in that type set.
The operands are represented as values of the type argument that the type parameter is
instantiated with, and the operation is computed with the precision of that type argument. For
example, given the function:
the product x * y and the addition s += x * y are computed with float32 or float64
precision, respectively, depending on the type argument for F.
Integer operators
For two integer values x and y, the integer quotient q = x / y and remainder r = x % y satisfy
the following relationships:
https://go.dev/ref/spec#Tokens 62/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
x y x / y x % y
5 3 1 2
-5 3 -1 -2
5 -3 -1 2
-5 -3 1 -2
The one exception to this rule is that if the dividend x is the most negative value for the int type
of x, the quotient q = x / -1 is equal to x (and r = 0) due to two's-complement integer
overflow:
x, q
int8 -128
int16 -32768
int32 -2147483648
int64 -9223372036854775808
If the divisor is a constant, it must not be zero. If the divisor is zero at run time, a run-time
panic occurs. If the dividend is non-negative and the divisor is a constant power of 2, the
division may be replaced by a right shift, and computing the remainder may be replaced by a
bitwise AND operation:
x x / 4 x % 4 x >> 2 x & 3
11 2 3 2 3
-11 -2 -3 -3 1
The shift operators shift the left operand by the shift count specified by the right operand,
which must be non-negative. If the shift count is negative at run time, a run-time panic occurs.
The shift operators implement arithmetic shifts if the left operand is a signed integer and logical
shifts if it is an unsigned integer. There is no upper limit on the shift count. Shifts behave as if
the left operand is shifted n times by 1 for a shift count of n. As a result, x << 1 is the same as
x*2 and x >> 1 is the same as x/2 but truncated towards negative infinity.
For integer operands, the unary operators +, -, and ^ are defined as follows:
+x is 0 + x
-x negation is 0 - x
^x bitwise complement is m ^ x with m = "all bits set to 1" for unsigned x
and m = -1 for signed x
Integer overflow
For unsigned integer values, the operations +, -, *, and << are computed modulo 2n, where n
is the bit width of the unsigned integer's type. Loosely speaking, these unsigned integer
operations discard high bits upon overflow, and programs may rely on "wrap around".
For signed integers, the operations +, -, *, /, and << may legally overflow and the resulting
value exists and is deterministically defined by the signed integer representation, the
operation, and its operands. Overflow does not cause a run-time panic. A compiler may not
https://go.dev/ref/spec#Tokens 63/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
optimize code under the assumption that overflow does not occur. For instance, it may not
assume that x < x + 1 is always true.
Floating-point operators
For floating-point and complex numbers, +x is the same as x, while -x is the negation of x.
The result of a floating-point or complex division by zero is not specified beyond the IEEE-754
standard; whether a run-time panic occurs is implementation-specific.
For instance, some architectures provide a "fused multiply and add" (FMA) instruction that
computes x*y + z without rounding the intermediate result x*y. These examples show when
a Go implementation can use that instruction:
String concatenation
s := "hi" + string(c)
s += " and good bye"
Comparison operators
Comparison operators compare two operands and yield an untyped boolean value.
== equal
!= not equal
< less
<= less or equal
> greater
>= greater or equal
https://go.dev/ref/spec#Tokens 64/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
In any comparison, the first operand must be assignable to the type of the second operand, or
vice versa.
The equality operators == and != apply to operands of comparable types. The ordering
operators <, <=, >, and >= apply to operands of ordered types. These terms and the result of
the comparisons are defined as follows:
Boolean types are comparable. Two boolean values are equal if they are either both
true or both false.
Integer types are comparable and ordered. Two integer values are compared in the usual
way.
Floating-point types are comparable and ordered. Two floating-point values are
compared as defined by the IEEE-754 standard.
Complex types are comparable. Two complex values u and v are equal if both real(u)
== real(v) and imag(u) == imag(v).
String types are comparable and ordered. Two string values are compared lexically byte-
wise.
Pointer types are comparable. Two pointer values are equal if they point to the same
variable or if both have value nil. Pointers to distinct zero-size variables may or may not
be equal.
Channel types are comparable. Two channel values are equal if they were created by the
same call to make or if both have value nil.
Interface types that are not type parameters are comparable. Two interface values are
equal if they have identical dynamic types and equal dynamic values or if both have
value nil.
A value x of non-interface type X and a value t of interface type T can be compared if
type X is comparable and X implements T. They are equal if t's dynamic type is identical
to X and t's dynamic value is equal to x.
Struct types are comparable if all their field types are comparable. Two struct values are
equal if their corresponding non-blank field values are equal. The fields are compared in
source order, and comparison stops as soon as two field values differ (or all fields have
been compared).
Array types are comparable if their array element types are comparable. Two array
values are equal if their corresponding element values are equal. The elements are
compared in ascending index order, and comparison stops as soon as two element
values differ (or all elements have been compared).
Type parameters are comparable if they are strictly comparable (see below).
A comparison of two interface values with identical dynamic types causes a run-time panic if
that type is not comparable. This behavior applies not only to direct interface value
comparisons but also when comparing arrays of interface values or structs with interface-
valued fields.
Slice, map, and function types are not comparable. However, as a special case, a slice, map,
or function value may be compared to the predeclared identifier nil. Comparison of pointer,
channel, and interface values to nil is also allowed and follows from the general rules above.
https://go.dev/ref/spec#Tokens 65/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
A type is strictly comparable if it is comparable and not an interface type nor composed of
interface types. Specifically:
Boolean, numeric, string, pointer, and channel types are strictly comparable.
Struct types are strictly comparable if all their field types are strictly comparable.
Array types are strictly comparable if their array element types are strictly comparable.
Type parameters are strictly comparable if all types in their type set are strictly
comparable.
Logical operators
Logical operators apply to boolean values and yield a result of the same type as the operands.
The left operand is evaluated, and then the right if the condition requires it.
Address operators
For an operand x of type T, the address operation &x generates a pointer of type *T to x. The
operand must be addressable, that is, either a variable, pointer indirection, or slice indexing
operation; or a field selector of an addressable struct operand; or an array indexing operation
of an addressable array. As an exception to the addressability requirement, x may also be a
(possibly parenthesized) composite literal. If the evaluation of x would cause a run-time panic,
then the evaluation of &x does too.
For an operand x of pointer type *T, the pointer indirection *x denotes the variable of type T
pointed to by x. If x is nil, an attempt to evaluate *x will cause a run-time panic.
&x
&a[f(2)]
&Point{2, 3}
*p
*pf(x)
https://go.dev/ref/spec#Tokens 66/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
*x // causes a run-time panic
&*x // causes a run-time panic
Receive operator
For an operand ch whose core type is a channel, the value of the receive operation <-ch is
the value received from the channel ch. The channel direction must permit receive operations,
and the type of the receive operation is the element type of the channel. The expression
blocks until a value is available. Receiving from a nil channel blocks forever. A receive
operation on a closed channel can always proceed immediately, yielding the element type's
zero value after any previously sent values have been received.
v1 := <-ch
v2 = <-ch
f(<-ch)
<-strobe // wait until clock pulse and discard received value
x, ok = <-ch
x, ok := <-ch
var x, ok = <-ch
var x, ok T = <-ch
yields an additional untyped boolean result reporting whether the communication succeeded.
The value of ok is true if the value received was delivered by a successful send operation to
the channel, or false if it is a zero value generated because the channel is closed and empty.
Conversions
A conversion changes the type of an expression to the type specified by the conversion. A
conversion may appear literally in the source, or it may be implied by the context in which an
expression appears.
If the type starts with the operator * or <-, or if the type starts with the keyword func and has
no result list, it must be parenthesized when necessary to avoid ambiguity:
https://go.dev/ref/spec#Tokens 67/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
(func() int)(x) // x is converted to func() int
func() int(x) // x is converted to func() int (unambiguous)
Converting a constant to a type that is not a type parameter yields a typed constant.
Converting a constant to a type parameter yields a non-constant value of that type, with the
value represented as a value of the type argument that the type parameter is instantiated with.
For example, given the function:
the conversion P(1.1) results in a non-constant value of type P and the value 1.1 is
represented as a float32 or a float64 depending on the type argument for f. Accordingly,
if f is instantiated with a float32 type, the numeric value of the expression P(1.1) + 1.2
will be computed with the same precision as the corresponding non-constant float32
addition.
x is assignable to T.
ignoring struct tags (see below), x's type and T are not type parameters but have
identical underlying types.
ignoring struct tags (see below), x's type and T are pointer types that are not named
types, and their pointer base types are not type parameters but have identical underlying
types.
x's type and T are both integer or floating point types.
x's type and T are both complex types.
x is an integer or a slice of bytes or runes and T is a string type.
x is a string and T is a slice of bytes or runes.
https://go.dev/ref/spec#Tokens 68/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
x is a slice, T is an array [Go 1.20] or a pointer to an array [Go 1.17], and the slice and
array types have identical element types.
Additionally, if T or x's type V are type parameters, x can also be converted to type T if one of
the following conditions applies:
Both V and T are type parameters and a value of each type in V's type set can be
converted to each type in T's type set.
Only V is a type parameter and a value of each type in V's type set can be converted to
T.
Only T is a type parameter and x can be converted to each type in T's type set.
Struct tags are ignored when comparing struct types for identity for the purpose of conversion:
var person = (*Person)(data) // ignoring tags, the underlying types are identica
Specific rules apply to (non-constant) conversions between numeric types or to and from a
string type. These conversions may change the representation of x and incur a run-time cost.
All other conversions only change the type but not the representation of x.
There is no linguistic mechanism to convert between pointers and integers. The package
unsafe implements this functionality under restricted circumstances.
For the conversion of non-constant numeric values, the following rules apply:
1. When converting between integer types, if the value is a signed integer, it is sign
extended to implicit infinite precision; otherwise it is zero extended. It is then truncated to
fit in the result type's size. For example, if v := uint16(0x10F0), then
uint32(int8(v)) == 0xFFFFFFF0. The conversion always yields a valid value; there
is no indication of overflow.
2. When converting a floating-point number to an integer, the fraction is discarded
(truncation towards zero).
https://go.dev/ref/spec#Tokens 69/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
In all non-constant conversions involving floating-point or complex values, if the result type
cannot represent the value the conversion succeeds but the result value is implementation-
dependent.
1. Converting a slice of bytes to a string type yields a string whose successive bytes are the
elements of the slice.
🌍
string([]myByte{'w', 'o', 'r', 'l', 'd', '!'}) // "world!"
myString([]myByte{'\xf0', '\x9f', '\x8c', '\x8d'}) // " "
2. Converting a slice of runes to a string type yields a string that is the concatenation of the
individual rune values converted to strings.
🌎
string([]myRune{0x266b, 0x266c}) // "\u266b\u266c" == "♫♬"
myString([]myRune{0x1f30e}) // "\U0001f30e" == " "
3. Converting a value of a string type to a slice of bytes type yields a non-nil slice whose
successive elements are the bytes of the string.
https://go.dev/ref/spec#Tokens 70/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
🌏"))
[]myByte("world!") // []myByte{'w', 'o', 'r', 'l', 'd', '!'}
[]myByte(myString(" // []myByte{'\xf0', '\x9f', '\x8c', '\x8f'}
4. Converting a value of a string type to a slice of runes type yields a slice containing the
individual Unicode code points of the string.
🌐"))
[]myRune("♫♬") // []myRune{0x266b, 0x266c}
[]myRune(myString(" // []myRune{0x1f310}
5. Finally, for historical reasons, an integer value may be converted to a string type. This
form of conversion yields a string containing the (possibly multi-byte) UTF-8
representation of the Unicode code point with the given integer value. Values outside the
range of valid Unicode code points are converted to "\uFFFD".
string('a') // "a"
string(65) // "A"
string('\xf8') // "\u00f8" == "ø" == "\xc3\xb8"
string(-1) // "\ufffd" == "\xef\xbf\xbd"
Note: This form of conversion may eventually be removed from the language. The go
vet tool flags certain integer-to-string conversions as potential errors. Library functions
such as utf8.AppendRune or utf8.EncodeRune should be used instead.
Converting a slice to an array yields an array containing the elements of the underlying array
of the slice. Similarly, converting a slice to an array pointer yields a pointer to the underlying
array of the slice. In both cases, if the length of the slice is less than the length of the array, a
run-time panic occurs.
s := make([]byte, 2, 4)
a0 := [0]byte(s)
a1 := [1]byte(s[1:]) // a1[0] == s[1]
a2 := [2]byte(s) // a2[0] == s[0]
a4 := [4]byte(s) // panics: len([4]byte) > len(s)
s0 := (*[0]byte)(s) // s0 != nil
s1 := (*[1]byte)(s[1:]) // &s1[0] == &s[1]
s2 := (*[2]byte)(s) // &s2[0] == &s[0]
s4 := (*[4]byte)(s) // panics: len([4]byte) > len(s)
var t []string
t0 := [0]string(t) // ok for nil slice t
https://go.dev/ref/spec#Tokens 71/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
t1 := (*[0]string)(t) // t1 == nil
t2 := (*[1]string)(t) // panics: len([1]string) > len(t)
u := make([]byte, 0)
u0 := (*[0]byte)(u) // u0 != nil
Constant expressions
Constant expressions may contain only constant operands and are evaluated at compile time.
Untyped boolean, numeric, and string constants may be used as operands wherever it is legal
to use an operand of boolean, numeric, or string type, respectively.
A constant comparison always yields an untyped boolean constant. If the left operand of a
constant shift expression is an untyped constant, the result is an integer constant; otherwise it
is a constant of the same type as the left operand, which must be of integer type.
Any other operation on untyped constants results in an untyped constant of the same kind; that
is, a boolean, integer, floating-point, complex, or string constant. If the untyped operands of a
binary operation (other than a shift) are of different kinds, the result is of the operand's kind
that appears later in this list: integer, rune, floating-point, complex. For example, an untyped
integer constant divided by an untyped complex constant yields an untyped complex constant.
Applying the built-in function complex to untyped integer, rune, or floating-point constants
yields an untyped complex constant.
Constant expressions are always evaluated exactly; intermediate values and the constants
themselves may require precision significantly larger than supported by any predeclared type
in the language. The following are legal declarations:
https://go.dev/ref/spec#Tokens 72/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
The values of typed constants must always be accurately representable by values of the
constant type. The following constant expressions are illegal:
The mask used by the unary bitwise complement operator ^ matches the rule for non-
constants: the mask is all 1s for unsigned constants and -1 for signed and untyped constants.
Implementation restriction: A compiler may use rounding while computing untyped floating-
point or complex constant expressions; see the implementation restriction in the section on
constants. This rounding may cause a floating-point constant expression to be invalid in an
integer context, even if it would be integral when calculated using infinite precision, and vice
versa.
Order of evaluation
the function calls and communication happen in the order f(), h() (if z evaluates to false),
i(), j(), <-c, g(), and k(). However, the order of those events compared to the evaluation
and indexing of x and the evaluation of y and z is not specified, except as required lexically.
For instance, g cannot be called before its arguments are evaluated.
https://go.dev/ref/spec#Tokens 73/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
a := 1
f := func() int { a++; return a }
x := []int{a, f()} // x may be [1, 2] or [2, 2]: evaluation order betw
m := map[int]int{a: 1, a: 2} // m may be {2: 1} or {2: 2}: evaluation order betw
n := map[int]int{a: f()} // n may be {2: 3} or {3: 3}: evaluation order betw
At package level, initialization dependencies override the left-to-right rule for individual
initialization expressions, but not for operands within each expression:
The function calls happen in the order u(), sqr(), v(), f(), v(), and g().
Statements
Statements control execution.
Statement =
Declaration | LabeledStmt | SimpleStmt |
GoStmt | ReturnStmt | BreakStmt | ContinueStmt | GotoStmt |
FallthroughStmt | Block | IfStmt | SwitchStmt | SelectStmt | ForStmt |
DeferStmt .
Terminating statements
A terminating statement interrupts the regular flow of control in a block. The following
statements are terminating:
https://go.dev/ref/spec#Tokens 74/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
A statement list ends in a terminating statement if the list is not empty and its final non-empty
statement is terminating.
Empty statements
EmptyStmt = .
Labeled statements
Expression statements
With the exception of specific built-in functions, function and method calls and receive
operations can appear in statement context. Such statements may be parenthesized.
ExpressionStmt = Expression .
https://go.dev/ref/spec#Tokens 75/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
h(x+y)
f.Close()
<-ch
(<-ch)
len("foo") // illegal if len is the built-in function
Send statements
A send statement sends a value on a channel. The channel expression's core type must be a
channel, the channel direction must permit send operations, and the type of the value to be
sent must be assignable to the channel's element type.
Both the channel and the value expression are evaluated before communication begins.
Communication blocks until the send can proceed. A send on an unbuffered channel can
proceed if a receiver is ready. A send on a buffered channel can proceed if there is room in the
buffer. A send on a closed channel proceeds by causing a run-time panic. A send on a nil
channel blocks forever.
IncDec statements
The "++" and "--" statements increment or decrement their operands by the untyped constant
1. As with an assignment, the operand must be addressable or a map index expression.
Assignment statements
An assignment replaces the current value stored in a variable with a new value specified by an
expression. An assignment statement may assign a single value to a single variable, or
multiple values to a matching number of variables.
https://go.dev/ref/spec#Tokens 76/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
Each left-hand side operand must be addressable, a map index expression, or (for =
assignments only) the blank identifier. Operands may be parenthesized.
x = 1
*p = f()
a[i] = 23
(k) = <-ch // same as: k = <-ch
a[i] <<= 2
i &^= 1<<n
x, y = f()
assigns the first value to x and the second to y. In the second form, the number of operands
on the left must equal the number of expressions on the right, each of which must be single-
valued, and the nth expression on the right is assigned to the nth operand on the left:
The blank identifier provides a way to ignore right-hand side values in an assignment:
The assignment proceeds in two phases. First, the operands of index expressions and pointer
indirections (including implicit pointer indirections in selectors) on the left and the expressions
on the right are all evaluated in the usual order. Second, the assignments are carried out in
left-to-right order.
a, b = b, a // exchange a and b
x := []int{1, 2, 3}
i := 0
https://go.dev/ref/spec#Tokens 77/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
i, x[i] = 1, 2 // set i = 1, x[0] = 2
i = 0
x[i], i = 2, 1 // set x[0] = 2, i = 1
i = 2
x = []int{3, 5, 7}
for i, x[i] = range x { // set i, x[2] = 0, x[0]
break
}
// after this loop, i == 0 and x is []int{3, 5, 3}
In assignments, each value must be assignable to the type of the operand to which it is
assigned, with the following special cases:
If statements
"If" statements specify the conditional execution of two branches according to the value of a
boolean expression. If the expression evaluates to true, the "if" branch is executed, otherwise,
if present, the "else" branch is executed.
if x > max {
x = max
}
The expression may be preceded by a simple statement, which executes before the
expression is evaluated.
if x := f(); x < y {
return x
} else if x > z {
return z
} else {
https://go.dev/ref/spec#Tokens 78/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
return y
}
Switch statements
There are two forms: expression switches and type switches. In an expression switch, the
cases contain expressions that are compared against the value of the switch expression. In a
type switch, the cases contain types that are compared against the type of a specially
annotated switch expression. The switch expression is evaluated exactly once in a switch
statement.
Expression switches
In an expression switch, the switch expression is evaluated and the case expressions, which
need not be constants, are evaluated left-to-right and top-to-bottom; the first one that equals
the switch expression triggers execution of the statements of the associated case; the other
cases are skipped. If no case matches and there is a "default" case, its statements are
executed. There can be at most one default case and it may appear anywhere in the "switch"
statement. A missing switch expression is equivalent to the boolean value true.
If the switch expression evaluates to an untyped constant, it is first implicitly converted to its
default type. The predeclared untyped value nil cannot be used as a switch expression. The
switch expression type must be comparable.
If a case expression is untyped, it is first implicitly converted to the type of the switch
expression. For each (possibly converted) case expression x and the value t of the switch
expression, x == t must be a valid comparison.
In other words, the switch expression is treated as if it were used to declare and initialize a
temporary variable t without explicit type; it is that value of t against which each case
expression x is tested for equality.
In a case or default clause, the last non-empty statement may be a (possibly labeled)
"fallthrough" statement to indicate that control should flow from the end of this clause to the
first statement of the next clause. Otherwise control flows to the end of the "switch" statement.
A "fallthrough" statement may appear as the last statement of all but the last clause of an
expression switch.
https://go.dev/ref/spec#Tokens 79/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
The switch expression may be preceded by a simple statement, which executes before the
expression is evaluated.
switch tag {
default: s3()
case 0, 1, 2, 3: s1()
case 4, 5, 6, 7: s2()
}
switch {
case x < y: f1()
case x < z: f2()
case x == 4: f3()
}
Type switches
A type switch compares types rather than values. It is otherwise similar to an expression
switch. It is marked by a special switch expression that has the form of a type assertion using
the keyword type rather than an actual type:
switch x.(type) {
// cases
}
Cases then match actual types T against the dynamic type of the expression x. As with type
assertions, x must be of interface type, but not a type parameter, and each non-interface type
T listed in a case must implement the type of x. The types listed in the cases of a type switch
must all be different.
The TypeSwitchGuard may include a short variable declaration. When that form is used, the
variable is declared at the end of the TypeSwitchCase in the implicit block of each clause. In
clauses with a case listing exactly one type, the variable has that type; otherwise, the variable
has the type of the expression in the TypeSwitchGuard.
https://go.dev/ref/spec#Tokens 80/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
Instead of a type, a case may use the predeclared identifier nil; that case is selected when
the expression in the TypeSwitchGuard is a nil interface value. There may be at most one
nil case.
switch i := x.(type) {
case nil:
printString("x is nil") // type of i is type of x (interfa
case int:
printInt(i) // type of i is int
case float64:
printFloat64(i) // type of i is float64
case func(int) float64:
printFunction(i) // type of i is func(int) float64
case bool, string:
printString("type is bool or string") // type of i is type of x (interfa
default:
printString("don't know the type") // type of i is type of x (interfa
}
could be rewritten:
A type parameter or a generic type may be used as a type in a case. If upon instantiation that
type turns out to duplicate another entry in the switch, the first matching case is chosen.
https://go.dev/ref/spec#Tokens 81/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
return 0
case string:
return 1
case []P:
return 2
case []byte:
return 3
default:
return 4
}
}
var v1 = f[string]("foo") // v1 == 0
var v2 = f[byte]([]byte{}) // v2 == 2
The type switch guard may be preceded by a simple statement, which executes before the
guard is evaluated.
For statements
A "for" statement specifies repeated execution of a block. There are three forms: The iteration
may be controlled by a single condition, a "for" clause, or a "range" clause.
In its simplest form, a "for" statement specifies the repeated execution of a block as long as a
boolean condition evaluates to true. The condition is evaluated before each iteration. If the
condition is absent, it is equivalent to the boolean value true.
for a < b {
a *= 2
}
A "for" statement with a ForClause is also controlled by its condition, but additionally it may
specify an init and a post statement, such as an assignment, an increment or decrement
statement. The init statement may be a short variable declaration, but the post statement must
not.
https://go.dev/ref/spec#Tokens 82/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
}
If non-empty, the init statement is executed once before evaluating the condition for the first
iteration; the post statement is executed after each execution of the block (and only if the block
was executed). Any element of the ForClause may be empty but the semicolons are required
unless there is only a condition. If the condition is absent, it is equivalent to the boolean value
true.
Each iteration has its own separate declared variable (or variables) [Go 1.22]. The variable
used by the first iteration is declared by the init statement. The variable used by each
subsequent iteration is declared implicitly before executing the post statement and initialized to
the value of the previous iteration's variable at that moment.
prints
1
3
5
Prior to [Go 1.22], iterations share one set of variables instead of having their own separate
variables. In that case, the example above prints
6
6
6
A "for" statement with a "range" clause iterates through all entries of an array, slice, string or
map, values received on a channel, or integer values from zero to an upper limit [Go 1.22]. For
each entry it assigns iteration values to corresponding iteration variables if present and then
executes the block.
https://go.dev/ref/spec#Tokens 83/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
The expression on the right in the "range" clause is called the range expression, its core type
must be an array, pointer to an array, slice, string, map, channel permitting receive operations,
or an integer. As with an assignment, if present the operands on the left must be addressable
or map index expressions; they denote the iteration variables. If the range expression is a
channel or integer, at most one iteration variable is permitted, otherwise there may be up to
two. If the last iteration variable is the blank identifier, the range clause is equivalent to the
same clause without that identifier.
The range expression x is evaluated once before beginning the loop, with one exception: if at
most one iteration variable is present and len(x) is constant, the range expression is not
evaluated.
Function calls on the left are evaluated once per iteration. For each iteration, iteration values
are produced as follows if the respective iteration variables are present:
1. For an array, pointer to array, or slice value a, the index iteration values are produced in
increasing order, starting at element index 0. If at most one iteration variable is present,
the range loop produces iteration values from 0 up to len(a)-1 and does not index into
the array or slice itself. For a nil slice, the number of iterations is 0.
2. For a string value, the "range" clause iterates over the Unicode code points in the string
starting at byte index 0. On successive iterations, the index value will be the index of the
first byte of successive UTF-8-encoded code points in the string, and the second value,
of type rune, will be the value of the corresponding code point. If the iteration
encounters an invalid UTF-8 sequence, the second value will be 0xFFFD, the Unicode
replacement character, and the next iteration will advance a single byte in the string.
3. The iteration order over maps is not specified and is not guaranteed to be the same from
one iteration to the next. If a map entry that has not yet been reached is removed during
iteration, the corresponding iteration value will not be produced. If a map entry is created
during iteration, that entry may be produced during the iteration or may be skipped. The
choice may vary for each entry created and from one iteration to the next. If the map is
nil, the number of iterations is 0.
4. For channels, the iteration values produced are the successive values sent on the
channel until the channel is closed. If the channel is nil, the range expression blocks
forever.
5. For an integer value n, the iteration values 0 through n-1 are produced in increasing
order. If n <= 0, the loop does not run any iterations.
The iteration variables may be declared by the "range" clause using a form of short variable
declaration (:=). In this case their scope is the block of the "for" statement and each iteration
has its own new variables [Go 1.22] (see also "for" statements with a ForClause). If the range
https://go.dev/ref/spec#Tokens 84/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
expression is a (possibly untyped) integer expression n, the variable has the same type as if it
was declared with initialization expression n. Otherwise, the variables have the types of their
respective iteration values.
If the iteration variables are not explicitly declared by the "range" clause, they must be
preexisting. In this case, the iteration values are assigned to the respective variables as in an
assignment statement. If the range expression is a (possibly untyped) integer expression n, n
too must be assignable to the iteration variable; if there is no iteration variable, n must be
assignable to int.
var a [10]string
for i, s := range a {
// type of i is int
// type of s is string
// s == a[i]
g(i, s)
}
// empty a channel
for range ch {}
https://go.dev/ref/spec#Tokens 85/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
for u = range 256 {
}
Go statements
A "go" statement starts the execution of a function call as an independent concurrent thread of
control, or goroutine, within the same address space.
The expression must be a function or method call; it cannot be parenthesized. Calls of built-in
functions are restricted as for expression statements.
The function value and parameters are evaluated as usual in the calling goroutine, but unlike
with a regular call, program execution does not wait for the invoked function to complete.
Instead, the function begins executing independently in a new goroutine. When the function
terminates, its goroutine also terminates. If the function has any return values, they are
discarded when the function completes.
go Server()
go func(ch chan<- bool) { for { sleep(10); ch <- true }} (c)
Select statements
A "select" statement chooses which of a set of possible send or receive operations will
proceed. It looks similar to a "switch" statement but with the cases all referring to
communication operations.
A case with a RecvStmt may assign the result of a RecvExpr to one or two variables, which
may be declared using a short variable declaration. The RecvExpr must be a (possibly
parenthesized) receive operation. There can be at most one default case and it may appear
anywhere in the list of cases.
1. For all the cases in the statement, the channel operands of receive operations and the
channel and right-hand-side expressions of send statements are evaluated exactly once,
in source order, upon entering the "select" statement. The result is a set of channels to
receive from or send to, and the corresponding values to send. Any side effects in that
evaluation will occur irrespective of which (if any) communication operation is selected to
proceed. Expressions on the left-hand side of a RecvStmt with a short variable
declaration or assignment are not yet evaluated.
https://go.dev/ref/spec#Tokens 86/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
2. If one or more of the communications can proceed, a single one that can proceed is
chosen via a uniform pseudo-random selection. Otherwise, if there is a default case, that
case is chosen. If there is no default case, the "select" statement blocks until at least one
of the communications can proceed.
3. Unless the selected case is the default case, the respective communication operation is
executed.
4. If the selected case is a RecvStmt with a short variable declaration or an assignment, the
left-hand side expressions are evaluated and the received value (or values) are
assigned.
5. The statement list of the selected case is executed.
Since communication on nil channels can never proceed, a select with only nil channels
and no default case blocks forever.
var a []int
var c, c1, c2, c3, c4 chan int
var i1, i2 int
select {
case i1 = <-c1:
print("received ", i1, " from c1\n")
case c2 <- i2:
print("sent ", i2, " to c2\n")
case i3, ok := (<-c3): // same as: i3, ok := <-c3
if ok {
print("received ", i3, " from c3\n")
} else {
print("c3 is closed\n")
}
case a[f()] = <-c4:
// same as:
// case t := <-c4
// a[f()] = t
default:
print("no communication\n")
}
Return statements
A "return" statement in a function F terminates the execution of F, and optionally provides one
or more result values. Any functions deferred by F are executed before F returns to its caller.
https://go.dev/ref/spec#Tokens 87/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
In a function without a result type, a "return" statement must not specify any result values.
func noResult() {
return
}
There are three ways to return values from a function with a result type:
1. The return value or values may be explicitly listed in the "return" statement. Each
expression must be single-valued and assignable to the corresponding element of the
function's result type.
2. The expression list in the "return" statement may be a single call to a multi-valued
function. The effect is as if each value returned from that function were assigned to a
temporary variable with the type of the respective value, followed by a "return" statement
listing these variables, at which point the rules of the previous case apply.
3. The expression list may be empty if the function's result type specifies names for its
result parameters. The result parameters act as ordinary local variables and the function
may assign values to them as necessary. The "return" statement returns the values of
these variables.
Regardless of how they are declared, all the result values are initialized to the zero values for
their type upon entry to the function. A "return" statement that specifies results sets the result
parameters before any deferred functions are executed.
Break statements
A "break" statement terminates execution of the innermost "for", "switch", or "select" statement
within the same function.
If there is a label, it must be that of an enclosing "for", "switch", or "select" statement, and that
is the one whose execution terminates.
OuterLoop:
for i = 0; i < n; i++ {
for j = 0; j < m; j++ {
switch a[i][j] {
case nil:
state = Error
break OuterLoop
case item:
state = Found
break OuterLoop
}
}
}
Continue statements
A "continue" statement begins the next iteration of the innermost enclosing "for" loop by
advancing control to the end of the loop block. The "for" loop must be within the same function.
If there is a label, it must be that of an enclosing "for" statement, and that is the one whose
execution advances.
RowLoop:
for y, row := range rows {
for x, data := range row {
if data == endOfRow {
continue RowLoop
}
row[x] = data + bias(x, y)
https://go.dev/ref/spec#Tokens 89/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
}
}
Goto statements
A "goto" statement transfers control to the statement with the corresponding label within the
same function.
goto Error
Executing the "goto" statement must not cause any variables to come into scope that were not
already in scope at the point of the goto. For instance, this example:
goto L // BAD
v := 3
L:
A "goto" statement outside a block cannot jump to a label inside that block. For instance, this
example:
if n%2 == 1 {
goto L1
}
for n > 0 {
f()
n--
L1:
f()
n--
}
is erroneous because the label L1 is inside the "for" statement's block but the goto is not.
Fallthrough statements
A "fallthrough" statement transfers control to the first statement of the next case clause in an
expression "switch" statement. It may be used only as the final non-empty statement in such a
clause.
FallthroughStmt = "fallthrough" .
Defer statements
A "defer" statement invokes a function whose execution is deferred to the moment the
surrounding function returns, either because the surrounding function executed a return
https://go.dev/ref/spec#Tokens 90/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
statement, reached the end of its function body, or because the corresponding goroutine is
panicking.
The expression must be a function or method call; it cannot be parenthesized. Calls of built-in
functions are restricted as for expression statements.
Each time a "defer" statement executes, the function value and parameters to the call are
evaluated as usual and saved anew but the actual function is not invoked. Instead, deferred
functions are invoked immediately before the surrounding function returns, in the reverse order
they were deferred. That is, if the surrounding function returns through an explicit return
statement, deferred functions are executed after any result parameters are set by that return
statement but before the function returns to its caller. If a deferred function value evaluates to
nil, execution panics when the function is invoked, not when the "defer" statement is
executed.
For instance, if the deferred function is a function literal and the surrounding function has
named result parameters that are in scope within the literal, the deferred function may access
and modify the result parameters before they are returned. If the deferred function has any
return values, they are discarded when the function completes. (See also the section on
handling panics.)
lock(l)
defer unlock(l) // unlocking happens before surrounding function returns
// f returns 42
func f() (result int) {
defer func() {
// result is accessed after it was set to 6 by the return stateme
result *= 7
}()
return 6
}
Built-in functions
Built-in functions are predeclared. They are called like any other function but some of them
accept a type instead of an expression as the first argument.
The built-in functions do not have standard Go types, so they can only appear in call
expressions; they cannot be used as function values.
The built-in functions append and copy assist in common slice operations. For both functions,
the result is independent of whether the memory referenced by the arguments overlaps.
The variadic function append appends zero or more values x to a slice s and returns the
resulting slice of the same type as s. The core type of s must be a slice of type []E. The
values x are passed to a parameter of type ...E and the respective parameter passing rules
apply. As a special case, if the core type of s is []byte, append also accepts a second
argument with core type bytestring followed by .... This form appends the bytes of the
byte slice or string.
If the capacity of s is not large enough to fit the additional values, append allocates a new,
sufficiently large underlying array that fits both the existing slice elements and the additional
values. Otherwise, append re-uses the underlying array.
s0 := []int{0, 0}
s1 := append(s0, 2) // append a single element s1 is []int{0,
s2 := append(s1, 3, 5, 7) // append multiple elements s2 is []int{0,
s3 := append(s2, s0...) // append a slice s3 is []int{0,
s4 := append(s3[3:6], s3[2:]...) // append overlapping slice s4 is []int{3,
var t []interface{}
t = append(t, 42, 3.1415, "foo") // t is []interfac
var b []byte
b = append(b, "bar"...) // append string contents b is []byte{'b'
The function copy copies slice elements from a source src to a destination dst and returns
the number of elements copied. The core types of both arguments must be slices with identical
element type. The number of elements copied is the minimum of len(src) and len(dst).
As a special case, if the destination's core type is []byte, copy also accepts a source
argument with core type bytestring. This form copies the bytes from the byte slice or string
into the byte slice.
Examples:
var a = [...]int{0, 1, 2, 3, 4, 5, 6, 7}
var s = make([]int, 6)
var b = make([]byte, 5)
n1 := copy(s, a[0:]) // n1 == 6, s is []int{0, 1, 2, 3, 4, 5}
n2 := copy(s, s[2:]) // n2 == 4, s is []int{2, 3, 4, 5, 4, 5}
n3 := copy(b, "Hello, World!") // n3 == 5, b is []byte("Hello")
Clear
https://go.dev/ref/spec#Tokens 92/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
The built-in function clear takes an argument of map, slice, or type parameter type, and
deletes or zeroes out all elements [Go 1.21].
If the type of the argument to clear is a type parameter, all types in its type set must be maps
or slices, and clear performs the operation corresponding to the actual type argument.
Close
For an argument ch with a core type that is a channel, the built-in function close records that
no more values will be sent on the channel. It is an error if ch is a receive-only channel.
Sending to or closing a closed channel causes a run-time panic. Closing the nil channel also
causes a run-time panic. After calling close, and after any previously sent values have been
received, receive operations will return the zero value for the channel's type without blocking.
The multi-valued receive operation returns a received value along with an indication of whether
the channel is closed.
Three functions assemble and disassemble complex numbers. The built-in function complex
constructs a complex value from a floating-point real and imaginary part, while real and imag
extract the real and imaginary parts of a complex value.
The type of the arguments and return value correspond. For complex, the two arguments
must be of the same floating-point type and the return type is the complex type with the
corresponding floating-point constituents: complex64 for float32 arguments, and
complex128 for float64 arguments. If one of the arguments evaluates to an untyped
constant, it is first implicitly converted to the type of the other argument. If both arguments
evaluate to untyped constants, they must be non-complex numbers or their imaginary parts
must be zero, and the return value of the function is an untyped complex constant.
For real and imag, the argument must be of complex type, and the return type is the
corresponding floating-point type: float32 for a complex64 argument, and float64 for a
https://go.dev/ref/spec#Tokens 93/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
The real and imag functions together form the inverse of complex, so for a value z of a
complex type Z, z == Z(complex(real(z), imag(z))).
If the operands of these functions are all constants, the return value is a constant.
The built-in function delete removes the element with key k from a map m. The value k must
be assignable to the key type of m.
If the type of m is a type parameter, all types in that type set must be maps, and they must all
have identical key types.
If the map m is nil or the element m[k] does not exist, delete is a no-op.
The built-in functions len and cap take arguments of various types and return a result of type
int. The implementation guarantees that the result always fits into an int.
https://go.dev/ref/spec#Tokens 94/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
chan T channel buffer capacity
type parameter see below
If the argument type is a type parameter P, the call len(e) (or cap(e) respectively) must be
valid for each type in P's type set. The result is the length (or capacity, respectively) of the
argument whose type corresponds to the type argument with which P was instantiated.
The capacity of a slice is the number of elements for which there is space allocated in the
underlying array. At any time the following relationship holds:
The length of a nil slice, map or channel is 0. The capacity of a nil slice or channel is 0.
The expression len(s) is constant if s is a string constant. The expressions len(s) and
cap(s) are constants if the type of s is an array or pointer to an array and the expression s
does not contain channel receives or (non-constant) function calls; in this case s is not
evaluated. Otherwise, invocations of len and cap are not constant and s is evaluated.
const (
c1 = imag(2i) // imag(2i) = 2.0 is a constant
c2 = len([10]float64{2}) // [10]float64{2} contains no function c
c3 = len([10]float64{c1}) // [10]float64{c1} contains no function
c4 = len([10]float64{imag(2i)}) // imag(2i) is a constant and no functio
c5 = len([10]float64{imag(z)}) // invalid: imag(z) is a (non-constant)
)
var z complex128
The built-in function make takes a type T, optionally followed by a type-specific list of
expressions. The core type of T must be a slice, map or channel. It returns a value of type T
(not *T). The memory is initialized as described in the section on initial values.
Each of the size arguments n and m must be of integer type, have a type set containing only
integer types, or be an untyped constant. A constant size argument must be non-negative and
representable by a value of type int; if it is an untyped constant it is given type int. If both n
https://go.dev/ref/spec#Tokens 95/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
and m are provided and are constant, then n must be no larger than m. For slices and
channels, if n is negative or larger than m at run time, a run-time panic occurs.
Calling make with a map type and size hint n will create a map with initial space to hold n map
elements. The precise behavior is implementation-dependent.
The built-in functions min and max compute the smallest—or largest, respectively—value of a
fixed number of arguments of ordered types. There must be at least one argument [Go 1.21].
The same type rules as for operators apply: for ordered arguments x and y, min(x, y) is
valid if x + y is valid, and the type of min(x, y) is the type of x + y (and similarly for max). If
all arguments are constant, the result is constant.
var x, y int
m := min(x) // m == x
m := min(x, y) // m is the smaller of x and y
m := max(x, y, 10) // m is the larger of x and y but at least 10
c := max(1, 2.0, 10) // c == 10.0 (floating-point kind)
f := max(0, float32(x)) // type of f is float32
var s []string
_ = min(s...) // invalid: slice arguments are not permitted
t := max("", "foo", "bar") // t == "foo" (string kind)
For numeric arguments, assuming all NaNs are equal, min and max are commutative and
associative:
min(x, y) == min(y, x)
min(x, y, z) == min(min(x, y), z) == min(x, min(y, z))
For floating-point arguments negative zero, NaN, and infinity the following rules apply:
x y min(x, y) max(x, y)
For string arguments the result for min is the first argument with the smallest (or for max,
largest) value, compared lexically byte-wise:
https://go.dev/ref/spec#Tokens 96/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
Allocation
The built-in function new takes a type T, allocates storage for a variable of that type at run
time, and returns a value of type *T pointing to it. The variable is initialized as described in the
section on initial values.
new(T)
For instance
allocates storage for a variable of type S, initializes it (a=0, b=0.0), and returns a value of type
*S containing the address of the location.
Handling panics
Two built-in functions, panic and recover, assist in reporting and handling run-time panics
and program-defined error conditions.
func panic(interface{})
func recover() interface{}
While executing a function F, an explicit call to panic or a run-time panic terminates the
execution of F. Any functions deferred by F are then executed as usual. Next, any deferred
functions run by F's caller are run, and so on up to any deferred by the top-level function in the
executing goroutine. At that point, the program is terminated and the error condition is
reported, including the value of the argument to panic. This termination sequence is called
panicking.
panic(42)
panic("unreachable")
panic(Error("cannot parse"))
https://go.dev/ref/spec#Tokens 97/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
The return value of recover is nil when the goroutine is not panicking or recover was not
called directly by a deferred function. Conversely, if a goroutine is panicking and recover was
called directly by a deferred function, the return value of recover is guaranteed not to be
nil. To ensure this, calling panic with a nil interface value (or an untyped nil) causes a
run-time panic.
The protect function in the example below invokes the function argument g and protects
callers from run-time panics raised by g.
Bootstrapping
Current implementations provide several built-in functions useful during bootstrapping. These
functions are documented for completeness but are not guaranteed to stay in the language.
They do not return a result.
Function Behavior
Implementation restriction: print and println need not accept arbitrary argument types, but
printing of boolean, numeric, and string types must be supported.
Packages
Go programs are constructed by linking together packages. A package in turn is constructed
from one or more source files that together declare constants, types, variables and functions
belonging to the package and which are accessible in all files of the same package. Those
elements may be exported and used in another package.
Each source file consists of a package clause defining the package to which it belongs,
followed by a possibly empty set of import declarations that declare packages whose contents
it wishes to use, followed by a possibly empty set of declarations of functions, types, variables,
and constants.
https://go.dev/ref/spec#Tokens 98/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
Package clause
A package clause begins each source file and defines the package to which the file belongs.
package math
A set of files sharing the same PackageName form the implementation of a package. An
implementation may require that all source files for a package inhabit the same directory.
Import declarations
An import declaration states that the source file containing the declaration depends on
functionality of the imported package (§Program initialization and execution) and enables
access to exported identifiers of that package. The import names an identifier (PackageName)
to be used for access and an ImportPath that specifies the package to be imported.
The PackageName is used in qualified identifiers to access exported identifiers of the package
within the importing source file. It is declared in the file block. If the PackageName is omitted, it
defaults to the identifier specified in the package clause of the imported package. If an explicit
period (.) appears instead of a name, all the package's exported identifiers declared in that
package's package block will be declared in the importing source file's file block and must be
accessed without a qualifier.
Implementation restriction: A compiler may restrict ImportPaths to non-empty strings using only
characters belonging to Unicode's L, M, N, P, and S general categories (the Graphic
characters without spaces) and may also exclude the characters !"#$%&'()*,:;<=>?
[\]^`{|} and the Unicode replacement character U+FFFD.
Consider a compiled a package containing the package clause package math, which exports
function Sin, and installed the compiled package in the file identified by "lib/math". This
table illustrates how Sin is accessed in files that import the package after the various types of
import declaration.
https://go.dev/ref/spec#Tokens 99/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
An import declaration declares a dependency relation between the importing and imported
package. It is illegal for a package to import itself, directly or indirectly, or to directly import a
package without referring to any of its exported identifiers. To import a package solely for its
side-effects (initialization), use the blank identifier as explicit package name:
import _ "lib/math"
An example package
package main
import "fmt"
func main() {
https://go.dev/ref/spec#Tokens 100/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
sieve()
}
When storage is allocated for a variable, either through a declaration or a call of new, or when
a new value is created, either through a composite literal or a call of make, and no explicit
initialization is provided, the variable or value is given a default value. Each element of such a
variable or value is set to the zero value for its type: false for booleans, 0 for numeric types,
"" for strings, and nil for pointers, functions, interfaces, slices, channels, and maps. This
initialization is done recursively, so for instance each element of an array of structs will have its
fields zeroed if no value is specified.
var i int
var i int = 0
After
t.i == 0
t.f == 0.0
t.next == nil
var t T
Package initialization
Within a package, package-level variable initialization proceeds stepwise, with each step
selecting the variable earliest in declaration order which has no dependencies on uninitialized
variables.
More precisely, a package-level variable is considered ready for initialization if it is not yet
initialized and either has no initialization expression or its initialization expression has no
dependencies on uninitialized variables. Initialization proceeds by repeatedly initializing the
next package-level variable that is earliest in declaration order and ready for initialization, until
there are no variables ready for initialization.
https://go.dev/ref/spec#Tokens 101/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
If any variables are still uninitialized when this process ends, those variables are part of one or
more initialization cycles, and the program is not valid.
Multiple variables on the left-hand side of a variable declaration initialized by single (multi-
valued) expression on the right-hand side are initialized together: If any of the variables on the
left-hand side is initialized, all those variables are initialized in the same step.
var x = a
var a, b = f() // a and b are initialized together, before x is initialized
For the purpose of package initialization, blank variables are treated like any other variables in
declarations.
The declaration order of variables declared in multiple files is determined by the order in which
the files are presented to the compiler: Variables declared in the first file are declared before
any of the variables declared in the second file, and so on. To ensure reproducible initialization
behavior, build systems are encouraged to present multiple files belonging to the same
package in lexical file name order to a compiler.
Dependency analysis does not rely on the actual values of the variables, only on lexical
references to them in the source, analyzed transitively. For instance, if a variable x's
initialization expression refers to a function whose body refers to variable y then x depends on
y. Specifically:
var (
a = c + b // == 9
b = f() // == 4
c = f() // == 5
d = 3 // == 5 after initialization has finished
)
https://go.dev/ref/spec#Tokens 102/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
the variable a will be initialized after b but whether x is initialized before b, between b and a, or
after a, and thus also the moment at which sideEffect() is called (before or after x is
initialized) is not specified.
Variables may also be initialized using functions named init declared in the package block,
with no arguments and no result parameters.
func init() { … }
Multiple such functions may be defined per package, even within a single source file. In the
package block, the init identifier can be used only to declare init functions, yet the
identifier itself is not declared. Thus init functions cannot be referred to from anywhere in a
program.
The entire package is initialized by assigning initial values to all its package-level variables
followed by calling all init functions in the order they appear in the source, possibly in
multiple files, as presented to the compiler.
Program initialization
The packages of a complete program are initialized stepwise, one package at a time. If a
package has imports, the imported packages are initialized before initializing the package
itself. If multiple packages import a package, the imported package will be initialized only once.
The importing of packages, by construction, guarantees that there can be no cyclic
initialization dependencies. More precisely:
Given the list of all packages, sorted by import path, in each step the first uninitialized package
in the list for which all imported packages (if any) are already initialized is initialized. This step
is repeated until all packages are initialized.
https://go.dev/ref/spec#Tokens 103/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
always sequences the init functions: it will not invoke the next one until the previous one has
returned.
Program execution
A complete program is created by linking a single, unimported package called the main
package with all the packages it imports, transitively. The main package must have package
name main and declare a function main that takes no arguments and returns no value.
func main() { … }
Program execution begins by initializing the program and then invoking the function main in
package main. When that function invocation returns, the program exits. It does not wait for
other (non-main) goroutines to complete.
Errors
The predeclared type error is defined as
It is the conventional interface for representing an error condition, with the nil value
representing no error. For instance, a function to read data from a file might be defined:
Run-time panics
Execution errors such as attempting to index an array out of bounds trigger a run-time panic
equivalent to a call of the built-in function panic with a value of the implementation-defined
interface type runtime.Error. That type satisfies the predeclared interface type error. The
exact error values that represent distinct run-time error conditions are unspecified.
package runtime
System considerations
Package unsafe
The built-in package unsafe, known to the compiler and accessible through the import path
"unsafe", provides facilities for low-level programming including operations that violate the
https://go.dev/ref/spec#Tokens 104/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
type system. A package using unsafe must be vetted manually for type safety and may not be
portable. The package provides the following interface:
package unsafe
type IntegerType int // shorthand for an integer type; it is not a real type
func Add(ptr Pointer, len IntegerType) Pointer
func Slice(ptr *ArbitraryType, len IntegerType) []ArbitraryType
func SliceData(slice []ArbitraryType) *ArbitraryType
func String(ptr *byte, len IntegerType) string
func StringData(str string) *byte
A Pointer is a pointer type but a Pointer value may not be dereferenced. Any pointer or
value of core type uintptr can be converted to a type of core type Pointer and vice versa.
The effect of converting between Pointer and uintptr is implementation-defined.
var f float64
bits = *(*uint64)(unsafe.Pointer(&f))
The functions Alignof and Sizeof take an expression x of any type and return the
alignment or size, respectively, of a hypothetical variable v as if v was declared via var v = x.
The function Offsetof takes a (possibly parenthesized) selector s.f, denoting a field f of
the struct denoted by s or *s, and returns the field offset in bytes relative to the struct's
address. If f is an embedded field, it must be reachable without pointer indirections through
fields of the struct. For a struct s with field f:
Computer architectures may require memory addresses to be aligned; that is, for addresses of
a variable to be a multiple of a factor, the variable's type's alignment. The function Alignof
takes an expression denoting a variable of any type and returns the alignment of the (type of
the) variable in bytes. For a variable x:
https://go.dev/ref/spec#Tokens 105/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
uintptr(unsafe.Pointer(&x)) % unsafe.Alignof(x) == 0
A (variable of) type T has variable size if T is a type parameter, or if it is an array or struct type
containing elements or fields of variable size. Otherwise the size is constant. Calls to
Alignof, Offsetof, and Sizeof are compile-time constant expressions of type uintptr if
their arguments (or the struct s in the selector expression s.f for Offsetof) are types of
constant size.
The function Add adds len to ptr and returns the updated pointer
unsafe.Pointer(uintptr(ptr) + uintptr(len)) [Go 1.17]. The len argument must
be of integer type or an untyped constant. A constant len argument must be representable by
a value of type int; if it is an untyped constant it is given type int. The rules for valid uses of
Pointer still apply.
The function Slice returns a slice whose underlying array starts at ptr and whose length and
capacity are len. Slice(ptr, len) is equivalent to
(*[len]ArbitraryType)(unsafe.Pointer(ptr))[:]
except that, as a special case, if ptr is nil and len is zero, Slice returns nil [Go 1.17].
The len argument must be of integer type or an untyped constant. A constant len argument
must be non-negative and representable by a value of type int; if it is an untyped constant it
is given type int. At run time, if len is negative, or if ptr is nil and len is not zero, a run-
time panic occurs [Go 1.17].
The function SliceData returns a pointer to the underlying array of the slice argument. If
the slice's capacity cap(slice) is not zero, that pointer is &slice[:1][0]. If slice is nil,
the result is nil. Otherwise it is a non-nil pointer to an unspecified memory address [Go
1.20].
The function String returns a string value whose underlying bytes start at ptr and whose
length is len. The same requirements apply to the ptr and len argument as in the function
Slice. If len is zero, the result is the empty string "". Since Go strings are immutable, the
bytes passed to String must not be modified afterwards. [Go 1.20]
The function StringData returns a pointer to the underlying bytes of the str argument. For
an empty string the return value is unspecified, and may be nil. Since Go strings are
immutable, the bytes returned by StringData must not be modified [Go 1.20].
https://go.dev/ref/spec#Tokens 106/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
uint32, int32, float32 4
uint64, int64, float64, complex64 8
complex128 16
A struct or array type has size zero if it contains no fields (or elements, respectively) that have
a size greater than zero. Two distinct zero-size variables may have the same address in
memory.
Appendix
Language versions
The Go 1 compatibility guarantee ensures that programs written to the Go 1 specification will
continue to compile and run correctly, unchanged, over the lifetime of that specification. More
generally, as adjustments are made and features added to the language, the compatibility
guarantee ensures that a Go program that works with a specific Go language version will
continue to work with any subsequent version.
For instance, the ability to use the prefix 0b for binary integer literals was introduced with Go
1.13, indicated by [Go 1.13] in the section on integer literals. Source code containing an
integer literal such as 0b1011 will be rejected if the implied or required language version used
by the compiler is older than Go 1.13.
The following table describes the minimum language version required for features introduced
after Go 1.
Go 1.9
Go 1.13
Integer literals may use the prefixes 0b, 0B, 0o, and 0O for binary, and octal literals,
respectively.
Hexadecimal floating-point literals may be written using the prefixes 0x and 0X.
The imaginary suffix i may be used with any (binary, decimal, hexadecimal) integer or
floating-point literal, not just decimal literals.
The digits of any number literal may be separated (grouped) using underscores _.
The shift count in a shift operation may be a signed integer type.
Go 1.14
https://go.dev/ref/spec#Tokens 107/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
Emdedding a method more than once through different embedded interfaces is not an
error.
Go 1.17
A slice may be converted to an array pointer if the slice and array element types match,
and the array is not longer than the slice.
The built-in package unsafe includes the new functions Add and Slice.
Go 1.18
The 1.18 release adds polymorphic functions and types ("generics") to the language.
Specifically:
Go 1.20
A slice may be converted to an array if the slice and array element types match and the
array is not longer than the slice.
The built-in package unsafe includes the new functions SliceData, String, and
StringData.
Comparable types (such as ordinary interfaces) may satisfy comparable constraints,
even if the type arguments are not strictly comparable.
Go 1.21
The set of predeclared functions includes the new functions min, max, and clear.
Type inference uses the types of interface methods for inference. It also infers type
arguments for generic functions assigned to variables or passed as arguments to other
(possibly generic) functions.
Go 1.22
In a "for" statement, each iteration has its own set of iteration variables rather than
sharing the same variables in each iteration.
A "for" statement with "range" clause may iterate over integer values from zero to an
upper limit.
The type unification rules describe if and how two types unify. The precise details are relevant
for Go implementations, affect the specifics of error messages (such as whether a compiler
reports a type inference or other error), and may explain why type inference fails in unusual
code situations. But by and large these rules can be ignored when writing Go code: type
https://go.dev/ref/spec#Tokens 108/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
inference is designed to mostly "work as expected", and the unification rules are fine-tuned
accordingly.
Type unification is controlled by a matching mode, which may be exact or loose. As unification
recursively descends a composite type structure, the matching mode used for elements of the
type, the element matching mode, remains the same as the matching mode except when two
types are unified for assignability (≡A): in this case, the matching mode is loose at the top level
but then changes to exact for element types, reflecting the fact that types don't have to be
identical to be assignable.
Two types that are not bound type parameters unify exactly if any of following conditions is
true:
If both types are bound type parameters, they unify per the given matching modes if:
A single bound type parameter P and another type T unify per the given matching modes if:
P doesn't have a known type argument. In this case, T is inferred as the type argument
for P.
P does have a known type argument A, A and T unify per the given matching modes, and
one of the following conditions is true:
Both A and T are interface types: In this case, if both A and T are also defined
types, they must be identical. Otherwise, if neither of them is a defined type, they
must have the same number of methods (unification of A and T already established
that the methods match).
Neither A nor T are interface types: In this case, if T is a defined type, T replaces A
as the inferred type argument for P.
Finally, two types that are not bound type parameters unify loosely (and per the element
matching mode) if:
https://go.dev/ref/spec#Tokens 109/110
08/07/2024, 21:04 The Go Programming Language Specification - The Go Programming Language
One type is a defined type, the other type is a type literal, but not an interface, and their
underlying types unify per the element matching mode.
Both types are interfaces (but not type parameters) with identical type terms, both or
neither embed the predeclared type comparable, corresponding method types unify
exactly, and the method set of one of the interfaces is a subset of the method set of the
other interface.
Only one type is an interface (but not a type parameter), corresponding methods of the
two types unify per the element matching mode, and the method set of the interface is a
subset of the method set of the other type.
Both types have the same structure and their element types unify per the element
matching mode.
https://go.dev/ref/spec#Tokens 110/110