Stowage/go
2
0
Fork 0
mirror of https://github.com/golang/go.git synced 2025-12-08 06:10:04 +00:00
Code Issues Projects Releases Packages Wiki Activity

embed: update docs for proposal tweaks

Browse source 
//go:embed variables can be type aliases.

//go:embed variables can't be local to a function.

For #43216
For #43602
Fixes #43978

Change-Id: Ib1d104dfa32b97c91d8bfc5ed5d461ca14da188f
Reviewed-on: https://go-review.googlesource.com/c/go/+/288072
Trust: Ian Lance Taylor <iant@golang.org>
Reviewed-by: Russ Cox <rsc@golang.org>
This commit is contained in:
Ian Lance Taylor 2021-01-29 10:25:34 -08:00
parent 68058edc39
commit 44361140c0
1 changed files with 16 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

22
src/embed/embed.go
View file

@ -9,18 +9,28 @@
// files read from the package directory or subdirectories at compile time. // files read from the package directory or subdirectories at compile time.
// //
// For example, here are three ways to embed a file named hello.txt // For example, here are three ways to embed a file named hello.txt
// and then print its contents at run time: // and then print its contents at run time.
// //
// import "embed" // Embedding one file into a string:
//
// import _ "embed"
// //
// //go:embed hello.txt // //go:embed hello.txt
// var s string // var s string
// print(s) // print(s)
// //
// Embedding one file into a slice of bytes:
//
// import _ "embed"
//
// //go:embed hello.txt // //go:embed hello.txt
// var b []byte // var b []byte
// print(string(b)) // print(string(b))
// //
// Embedded one or more files into a file system:
//
// import "embed"
//
// //go:embed hello.txt // //go:embed hello.txt
// var f embed.FS // var f embed.FS
// data, _ := f.ReadFile("hello.txt") // data, _ := f.ReadFile("hello.txt")
@ -34,8 +44,8 @@
// The directive must immediately precede a line containing the declaration of a single variable. // The directive must immediately precede a line containing the declaration of a single variable.
// Only blank lines and ‘//’ line comments are permitted between the directive and the declaration. // Only blank lines and ‘//’ line comments are permitted between the directive and the declaration.
// //
// The variable must be of type string, []byte, or FS exactly. Named types or type aliases // The type of the variable must be a string type, or a slice of a byte type,
// derived from those types are not allowed. // or FS (or an alias of FS).
// //
// For example: // For example:
// //
@ -70,8 +80,8 @@
// //
// The //go:embed directive can be used with both exported and unexported variables, // The //go:embed directive can be used with both exported and unexported variables,
// depending on whether the package wants to make the data available to other packages. // depending on whether the package wants to make the data available to other packages.
// Similarly, it can be used with both global and function-local variables, // It can only be used with global variables at package scope,
// depending on what is more convenient in context. // not with local variables.
// //
// Patterns must not match files outside the package's module, such as ‘.git/*’ or symbolic links. // Patterns must not match files outside the package's module, such as ‘.git/*’ or symbolic links.
// Matches for empty directories are ignored. After that, each pattern in a //go:embed line // Matches for empty directories are ignored. After that, each pattern in a //go:embed line