Clarify layout information in Layout::extend

This commit is contained in:
CAD97 2020-04-17 18:59:36 -04:00
parent 5f1fd9da54
commit a01b00faf8

View file

@ -258,9 +258,11 @@ impl Layout {
/// Creates a layout describing the record for `self` followed by
/// `next`, including any necessary padding to ensure that `next`
/// will be properly aligned, but *no trailing padding*. In order to
/// match C representation layout, you should call `pad_to_align`
/// after extending the layout with all fields.
/// will be properly aligned, but *no trailing padding*. In order
/// to match C representation layout `repr(C)`, you should call
/// `pad_to_align` after extending the layout with all fields.
/// (There is no way to match the default Rust representation
/// layout `repr(Rust)`, as it is unspecified.)
///
/// Note that the resulting layout will satisfy the alignment properties
/// of both `self` and `next`, in order to ensure alignment of both parts.