qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-13 19:10:22 -07:00
Code Releases Activity

unsafe: clarify that Alignof returns required alignment

Browse Source 
Also document the special behavior of Alignof(s.f), and mention the
correspondence between Alignof and reflect.Type.{Align,FieldAlign}.

Change-Id: I6f81047a04c86887f1b1164473225616cae45a26
Reviewed-on: https://go-review.googlesource.com/18949
Run-TryBot: Ian Lance Taylor <iant@golang.org>
Reviewed-by: Russ Cox <rsc@golang.org>
This commit is contained in:
Ian Lance Taylor 2016-01-26 17:23:33 -08:00
parent 867bef93b9
commit f49a757ad0
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/unsafe/unsafe.go
View File

@ -183,7 +183,12 @@ func Sizeof(x ArbitraryType) uintptr
// number of bytes between the start of the struct and the start of the field.
func Offsetof(x ArbitraryType) uintptr
// Alignof takes an expression x of any type and returns the 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.
// It is the largest value m such that the address of v is 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().
// As a special case, if s has a struct type and f is a field 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 value returned
// by reflect.TypeOf(s.f).FieldAlign().
func Alignof(x ArbitraryType) uintptr