The providers are the outputs of the rules. You generaly get them by having a dependency on a rule, and then asking for a provider of a specific type.
The Go providers are designed primarily for the efficiency of the Go rules. The information they share is mostly there because it is required for the core rules to work.
All the providers are designed to hold only immutable data. This is partly because its a cleaner design choice to be able to assume a provider will never change, but also because only immutable objects are allowed to be stored in a depset, and it's really useful to have depsets of providers. Specifically the direct and transitive fields on GoLibrary only work because it is immutable.
GoLibrary contains metadata about an individual library. It is provided
by the go_library rule and other compatible rules. In general, you should
build GoLibrary with the new_library helper method. GoLibrary is
an input to the library_to_source helper method, which produces GoSource.
| Name | Type |
| name | string |
The name of the library. Usually, this is the name attribute. |
|
| label | Label |
| The full label for the library. | |
| importpath | string |
The string used in import declarations in Go source code to import
this library. Usually, this is the importpath attribute. |
|
| importmap | string |
The package path for this library. The Go compiler and linker internally refer
to the library using this string. It must be unique in any binary the library
is linked into. This is usually the same as importpath, but it may be
different, especially for vendored libraries. |
|
| pathtype | string |
Information about the source of the importpath. Possible values are:
|
|
| resolve | function (optional) |
| A function called by library_to_source that can be used to resolve this library to a mode-specific GoSource. | |
| is_main | bool |
| Indicates whether the library should be compiled as a main package. main packages may have arbitrary importpath and importmap values, but the compiler and linker must see them as main. | |
GoSource represents a GoLibrary after mode-specific processing, ready to build a GoArchive. This is produced by calling the library_to_source helper method. In general, only rules_go should need to build or handle these.
| Name | Type |
| library | GoLibrary |
| The go library that this GoSource was generated from. | |
| mode | Mode |
| The mode this library is being built for. | |
| srcs | list of File |
| The sources to compile into the archive. | |
| orig_srcs | list of File |
| The original source files this library is based on. This may differ from srcs if processing tools such as cgo or cover are applied. | |
| orig_src_map | dict of File to File |
| Maps generated files in srcs back to orig_srcs. Not all generated files may appear in here. | |
| embedsrcs | list of File |
Files that may be embedded into the compiled package using //go:embed
directives. All files must be in the same logical directory or a subdirectory
as source files. However, it's okay to mix static and generated source files
and static and generated embeddable files. |
|
| cover | list of File |
| List of source files to instrument for code coverage. | |
| x_defs | string_dict |
| Map of defines to add to the go link command. | |
| deps | list of Target |
| The direct dependencies needed by this library. | |
| gc_goopts | list of string |
| Go compilation options that should be used when compiling these sources. In general these will be used for all sources of any library this provider is embedded into. | |
| runfiles | Runfiles |
| The set of files needed by code in these sources at runtime. | |
| cgo | bool |
True if the library may contain cgo sources or C/C++/ObjC sources.
If true and cgo is enabled, cgo sources will be processed with cgo, and
C/C++/ObjC will be compiled with the appropriate toolchain and packed into
the final archive. If true and cgo is disabled, cgo sources are filtered
out, and sources with // +build !cgo are included. |
|
| cdeps | list of Target |
List of cc_library and objc_library targets this library depends on. |
|
| cppopts | list of string |
| List of additional flags to pass to the C preprocessor when invoking the C/C++/ObjC compilers. | |
| copts | list of string |
| List of additional flags to pass to the C compiler. | |
| cxxopts | list of string |
| List of additional flags to pass to the C++ compiler. | |
| clinkopts | list of string |
| List of additional flags to pass to the external linker. | |
| cgo_deps | list of File |
Deprecated; use cdeps instead. The direct cgo dependencies of this library. |
|
| cgo_exports | list of File |
| The exposed cc headers for these sources. | |
GoArchiveData contains information about a compiled Go package. GoArchiveData
only contains immutable information about a package itself. It does not contain
any information about dependencies or references to other providers. This makes
it suitable to include in depsets. GoArchiveData is not directly returned by any
rule. Instead, it's referenced in the data field of GoArchive.
| Name | Type |
| name | string |
The name of the library. Usually the same as the name attribute. |
|
| label | Label |
| The full label for the library. | |
| importpath | string |
The string used in import declarations in Go source code to import this
library. Usually, this is the importpath attribute. |
|
| importmap | string |
The package path for this library. The Go compiler and linker internally refer
to the library using this string. It must be unique in any binary the library
is linked into. This is usually the same as importpath, but it may be
different, especially for vendored libraries. |
|
| pathtype | string |
Information about the source of the importpath. Possible values are:
|
|
| file | File |
| The archive file produced when this library is compiled. | |
| srcs | tuple of File |
| The .go sources compiled into the archive. May have been generated or transformed with tools like cgo and cover. | |
| orig_srcs | tuple of File |
| The unmodified sources provided to the rule, including .go, .s, .h, .c files. | |
| data_files | tuple of File |
| Data files that should be available at runtime to binaries and tests built from this archive. | |
GoArchive contains information about a compiled archive and its dependencies
(both direct and transitive). This is used when compiling and linking Go
libraries and binaries. It is produced by the archive toolchain function.
Most of the metadata about the archive itself is available in GoArchiveData, which is available through the data field.
| Name | Type |
| source | GoSource |
| The source provider this GoArchive was compiled from. | |
| data | GoArchiveData |
| The non transitive data for this archive. | |
| direct | list of GoArchive |
| The direct dependencies of this archive. | |
| libs | depset of File |
| The transitive set of libraries needed to link with this archive. | |
| transitive | depset of GoArchiveData |
The full set of transitive dependencies. This includes data for this
archive and all data members transitively reachable through direct. |
|
| x_defs | string_dict |
| The full transitive set of defines to add to the go link command. | |
| cgo_deps | depset(cc_library) |
| The direct cgo dependencies of this library. This has the same constraints as things that can appear in the deps of a cc_library. | |
| cgo_exports | depset of GoSource |
| The the transitive set of c headers needed to reference exports of this archive. | |
| runfiles | runfiles |
| The files needed to run anything that includes this library. | |
| mode | Mode |
| The mode this archive was compiled in. | |
GoPath is produced by the go_path rule. It gives a list of packages used to
build the go_path directory and provides a list of original files for each
package.
| Name | Type |
| gopath | string |
The short path to the output file or directory. Useful for constructing
runfiles paths. |
|
| gopath_file | File |
A Bazel File that points to the output directory.
|
|
| packages | list of struct |
A list of structs representing packages used to build the |
|
GoSDK contains information about the Go SDK used in the toolchain.
| Name | Type |
| goos | string |
| The host operating system the SDK was built for. | |
| goarch | string |
| The host architecture the SDK was built for. | |
| root_file | File |
A file in the SDK root directory. Used to determine GOROOT. |
|
| libs | list of File |
| Pre-compiled .a files for the standard library, built for the execution platform. | |
| headers | list of File |
| .h files from pkg/include that may be included in assembly sources. | |
| srcs | list of File |
| Source files for importable packages in the standard library. Internal, vendored, and tool packages might not be included. | |
| package_list | File |
| A file containing a list of importable packages in the standard library. | |
| tools | list of File |
| Executable files from pkg/tool built for the execution platform. | |
| go | File |
| The go binary file. | |
GoStdLib contains information about the standard library being used for
compiling and linking. The standard library may be the pre-compiled library
from GoSDK, or it may be another library compiled for the target mode.
| Name | Type |
| root_file | File |
A file in the standard library root directory. Used to determine GOROOT. |
|
| libs | list of File |
| .a files for the standard library, built for the target platform. | |