diff options
| author | Carol (Nichols || Goulding) <carol.nichols@gmail.com> | 2016-05-21 11:54:29 -0400 |
|---|---|---|
| committer | Carol (Nichols || Goulding) <carol.nichols@gmail.com> | 2016-05-23 10:03:44 -0400 |
| commit | fc467b31c2db57762ffed20a1305bb8830178071 (patch) | |
| tree | fc9214f6f445e19d680e1f83720eace029898c41 /src/libcore | |
| parent | 2f4405333243c3bb0b3a210201c98a69fe7a1c4a (diff) | |
| download | rust-fc467b31c2db57762ffed20a1305bb8830178071.tar.gz rust-fc467b31c2db57762ffed20a1305bb8830178071.zip | |
Reorder `Copy` doc sections
The new order puts all the "when" questions together and puts the "how" question with the "derivable" section. So you have to scroll past (and hopefully read) the can/cannot/should caveats and guidelines to get to the information about how to actually go about doing it once you've determined that you can and should, with derivable information first so that you can just use the derived implementation if that applies. Previous order: * General explanation * When can my type be `Copy`? * How can I implement `Copy`? * When can my type _not_ be `Copy`? * When should my type be `Copy`? * Derivable New order: * General explanation * When can my type be `Copy`? * When can my type _not_ be `Copy`? * When should my type be `Copy`? * Derivable * How can I implement `Copy`?
Diffstat (limited to 'src/libcore')
| -rw-r--r-- | src/libcore/marker.rs | 40 |
1 files changed, 20 insertions, 20 deletions
diff --git a/src/libcore/marker.rs b/src/libcore/marker.rs index 150a091c4bd..c18d230be31 100644 --- a/src/libcore/marker.rs +++ b/src/libcore/marker.rs @@ -136,26 +136,6 @@ pub trait Unsize<T: ?Sized> { /// the trait `Copy` may not be implemented for this type; field `points` does not implement `Copy` /// ``` /// -/// ## How can I implement `Copy`? -/// -/// There are two ways to implement `Copy` on your type: -/// -/// ``` -/// #[derive(Copy, Clone)] -/// struct MyStruct; -/// ``` -/// -/// and -/// -/// ``` -/// struct MyStruct; -/// impl Copy for MyStruct {} -/// impl Clone for MyStruct { fn clone(&self) -> MyStruct { *self } } -/// ``` -/// -/// There is a small difference between the two: the `derive` strategy will also place a `Copy` -/// bound on type parameters, which isn't always desired. -/// /// ## When can my type _not_ be `Copy`? /// /// Some types can't be copied safely. For example, copying `&mut T` would create an aliased @@ -175,6 +155,26 @@ pub trait Unsize<T: ?Sized> { /// /// This trait can be used with `#[derive]` if all of its components implement `Copy` and the type /// implements `Clone`. The implementation will copy the bytes of each field using `memcpy`. +/// +/// ## How can I implement `Copy`? +/// +/// There are two ways to implement `Copy` on your type: +/// +/// ``` +/// #[derive(Copy, Clone)] +/// struct MyStruct; +/// ``` +/// +/// and +/// +/// ``` +/// struct MyStruct; +/// impl Copy for MyStruct {} +/// impl Clone for MyStruct { fn clone(&self) -> MyStruct { *self } } +/// ``` +/// +/// There is a small difference between the two: the `derive` strategy will also place a `Copy` +/// bound on type parameters, which isn't always desired. #[stable(feature = "rust1", since = "1.0.0")] #[lang = "copy"] pub trait Copy : Clone { |