Improve documentation of `slice::from_raw_parts` #72350

danielhenrymantilla · 2020-05-19T14:00:08Z

This is to provide a more explicit statement against a code pattern that
many people end up coming with, since the reason of it being unsound
comes from the badly known single-allocation validity rule.

Providing that very pattern as a counter-example could help mitigate that.

See also: https://internals.rust-lang.org/t/pre-rfc-add-join-seq-method-to-slices-and-strs/11936/13

r? @RalfJung

src/libcore/slice/mod.rs

RalfJung · 2020-05-20T07:05:43Z

Thanks for the PR. :) I just have a few nits.

danielhenrymantilla · 2020-05-20T13:22:15Z

Preview:

src/libcore/slice/mod.rs

RalfJung · 2020-05-21T11:54:22Z

Looking good. :) Could you please squash, then I'll r+.

This is to provide a more explicit statement against a code pattern that many people end up coming with, since the reason of it being unsound comes from the badly known single-allocation validity rule. Providing that very pattern as a counter-example could help mitigate that. Co-authored-by: Ralf Jung <post@ralfj.de>

src/libcore/slice/mod.rs

RalfJung · 2020-05-21T17:08:19Z

Thanks! @bors r+ rollup+

bors · 2020-05-21T17:08:20Z

📌 Commit 67e0755 has been approved by RalfJung

RalfJung · 2020-05-21T17:08:39Z

@bors rollup

@RalfJung

…t_adjacent_slice_concat, r=RalfJung Improve documentation of `slice::from_raw_parts` This is to provide a more explicit statement against a code pattern that many people end up coming with, since the reason of it being unsound comes from the badly known single-allocation validity rule. Providing that very pattern as a counter-example could help mitigate that. See also: https://internals.rust-lang.org/t/pre-rfc-add-join-seq-method-to-slices-and-strs/11936/13 r? @RalfJung

@ghost

Rollup of 7 pull requests Successful merges: - rust-lang#72055 (Intern predicates) - rust-lang#72149 (Don't `type_of` on trait assoc ty without default) - rust-lang#72347 (Make intra-link resolve links for both trait and impl items) - rust-lang#72350 (Improve documentation of `slice::from_raw_parts`) - rust-lang#72382 (Show default values for debug-assertions & debug-assertions-std) - rust-lang#72421 (Fix anchor display when hovering impl) - rust-lang#72425 (fix discriminant_value sign extension) Failed merges: r? @ghost

rust-highfive assigned RalfJung May 19, 2020

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 19, 2020

This comment has been minimized.

Sign in to view

danielhenrymantilla force-pushed the doc_warn_against_adjacent_slice_concat branch from 730119c to 8bc3a33 Compare May 19, 2020 15:27

RalfJung reviewed May 20, 2020

View reviewed changes