mirror
/
go
mirror of https://github.com/golang/go.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

unsafe: add available godoc link 

Change-Id: I1391ec36063dc609a61cc3b37827a56c7cf97c03
Reviewed-on: https://go-review.googlesource.com/c/go/+/539839
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: David Chase <drchase@google.com>
Reviewed-by: qiulaidongfeng <2645477756@qq.com>
Reviewed-by: Ian Lance Taylor <iant@google.com>
Auto-Submit: Ian Lance Taylor <iant@golang.org>
This commit is contained in:
cui fliter 2023-11-05 18:48:27 +08:00 committed by Gopher Robot
parent 0c77b0d0e0
commit b4f37e18b6
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/unsafe/unsafe.go
View File

@ -110,7 +110,7 @@ type IntegerType int
// u := unsafe.Pointer(nil) // u := unsafe.Pointer(nil)
// p := unsafe.Pointer(uintptr(u) + offset) // p := unsafe.Pointer(uintptr(u) + offset)
// //
// (4) Conversion of a Pointer to a uintptr when calling syscall.Syscall. // (4) Conversion of a Pointer to a uintptr when calling [syscall.Syscall].
// //
// The Syscall functions in package syscall pass their uintptr arguments directly // The Syscall functions in package syscall pass their uintptr arguments directly
// to the operating system, which then may, depending on the details of the call, // to the operating system, which then may, depending on the details of the call,
@ -137,7 +137,7 @@ type IntegerType int
// u := uintptr(unsafe.Pointer(p)) // u := uintptr(unsafe.Pointer(p))
// syscall.Syscall(SYS_READ, uintptr(fd), u, uintptr(n)) // syscall.Syscall(SYS_READ, uintptr(fd), u, uintptr(n))
// //
// (5) Conversion of the result of reflect.Value.Pointer or reflect.Value.UnsafeAddr // (5) Conversion of the result of [reflect.Value.Pointer] or [reflect.Value.UnsafeAddr]
// from uintptr to Pointer. // from uintptr to Pointer.
// //
// Package reflect's Value methods named Pointer and UnsafeAddr return type uintptr // Package reflect's Value methods named Pointer and UnsafeAddr return type uintptr
@ -155,7 +155,7 @@ type IntegerType int
// u := reflect.ValueOf(new(int)).Pointer() // u := reflect.ValueOf(new(int)).Pointer()
// p := (*int)(unsafe.Pointer(u)) // p := (*int)(unsafe.Pointer(u))
// //
// (6) Conversion of a reflect.SliceHeader or reflect.StringHeader Data field to or from Pointer. // (6) Conversion of a [reflect.SliceHeader] or [reflect.StringHeader] Data field to or from Pointer.
// //
// As in the previous case, the reflect data structures SliceHeader and StringHeader // As in the previous case, the reflect data structures SliceHeader and StringHeader
// declare the field Data as a uintptr to keep callers from changing the result to // declare the field Data as a uintptr to keep callers from changing the result to
@ -171,7 +171,7 @@ type IntegerType int
// In this usage hdr.Data is really an alternate way to refer to the underlying // In this usage hdr.Data is really an alternate way to refer to the underlying
// pointer in the string header, not a uintptr variable itself. // pointer in the string header, not a uintptr variable itself.
// //
// In general, reflect.SliceHeader and reflect.StringHeader should be used // In general, [reflect.SliceHeader] and [reflect.StringHeader] should be used
// only as *reflect.SliceHeader and *reflect.StringHeader pointing at actual // only as *reflect.SliceHeader and *reflect.StringHeader pointing at actual
// slices or strings, never as plain structs. // slices or strings, never as plain structs.
// A program should not declare or allocate variables of these struct types. // A program should not declare or allocate variables of these struct types.
@ -206,18 +206,18 @@ func Offsetof(x ArbitraryType) uintptr
// Alignof takes an expression x of any type and returns the required alignment // Alignof takes an expression x of any type and returns the required alignment
// of a hypothetical variable v as if v was declared via var v = x. // of a hypothetical variable v as if v was declared via var v = x.
// It is the largest value m such that the address of v is always zero mod m. // It is the largest value m such that the address of v is always zero mod m.
// It is the same as the value returned by reflect.TypeOf(x).Align(). // It is the same as the value returned by [reflect.TypeOf](x).Align().
// As a special case, if a variable s is of struct type and f is a field // As a special case, if a variable s is of struct type and f is a field
// within that struct, then Alignof(s.f) will return the required alignment // within that struct, then Alignof(s.f) will return the required alignment
// of a field of that type within a struct. This case is the same as the // of a field of that type within a struct. This case is the same as the
// value returned by reflect.TypeOf(s.f).FieldAlign(). // value returned by [reflect.TypeOf](s.f).FieldAlign().
// The return value of Alignof is a Go constant if the type of the argument // The return value of Alignof is a Go constant if the type of the argument
// does not have variable size. // does not have variable size.
// (See the description of [Sizeof] for a definition of variable sized types.) // (See the description of [Sizeof] for a definition of variable sized types.)
func Alignof(x ArbitraryType) uintptr func Alignof(x ArbitraryType) uintptr
// The function Add adds len to ptr and returns the updated pointer // The function Add adds len to ptr and returns the updated pointer
// Pointer(uintptr(ptr) + uintptr(len)). // [Pointer](uintptr(ptr) + uintptr(len)).
// The len argument must be of integer type or an untyped constant. // 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; // A constant len argument must be representable by a value of type int;
// if it is an untyped constant it is given type int. // if it is an untyped constant it is given type int.