]>
git.proxmox.com Git - rustc.git/blob - src/libcore/clone.rs
1 // Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 //! The `Clone` trait for types that cannot be 'implicitly copied'.
13 //! In Rust, some simple types are "implicitly copyable" and when you
14 //! assign them or pass them as arguments, the receiver will get a copy,
15 //! leaving the original value in place. These types do not require
16 //! allocation to copy and do not have finalizers (i.e. they do not
17 //! contain owned boxes or implement `Drop`), so the compiler considers
18 //! them cheap and safe to copy. For other types copies must be made
19 //! explicitly, by convention implementing the `Clone` trait and calling
20 //! the `clone` method.
22 //! Basic usage example:
25 //! let s = String::new(); // String type implements Clone
26 //! let copy = s.clone(); // so we can clone it
29 //! To easily implement the Clone trait, you can also use
30 //! `#[derive(Clone)]`. Example:
33 //! #[derive(Clone)] // we add the Clone trait to Morpheus struct
40 //! let f = Morpheus { blue_pill: 0.0, red_pill: 0 };
41 //! let copy = f.clone(); // and now we can clone it!
45 #![stable(feature = "rust1", since = "1.0.0")]
49 /// A common trait for cloning an object.
51 /// This trait can be used with `#[derive]`.
52 #[stable(feature = "rust1", since = "1.0.0")]
53 pub trait Clone
: Sized
{
54 /// Returns a copy of the value.
59 /// let hello = "Hello"; // &str implements Clone
61 /// assert_eq!("Hello", hello.clone());
63 #[stable(feature = "rust1", since = "1.0.0")]
64 fn clone(&self) -> Self;
66 /// Performs copy-assignment from `source`.
68 /// `a.clone_from(&b)` is equivalent to `a = b.clone()` in functionality,
69 /// but can be overridden to reuse the resources of `a` to avoid unnecessary
72 #[stable(feature = "rust1", since = "1.0.0")]
73 fn clone_from(&mut self, source
: &Self) {
74 *self = source
.clone()
78 #[stable(feature = "rust1", since = "1.0.0")]
79 impl<'a
, T
: ?Sized
> Clone
for &'a T
{
80 /// Returns a shallow copy of the reference.
82 fn clone(&self) -> &'a T { *self }
85 macro_rules
! clone_impl
{
87 #[stable(feature = "rust1", since = "1.0.0")]
89 /// Returns a deep copy of the value.
91 fn clone(&self) -> $t { *self }
102 clone_impl
! { usize }