]>
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 #![stable(feature = "rust1", since = "1.0.0")]
26 /// A common trait for cloning an object.
28 /// This trait can be used with `#[derive]`.
29 #[stable(feature = "rust1", since = "1.0.0")]
30 pub trait Clone
: Sized
{
31 /// Returns a copy of the value.
36 /// let hello = "Hello"; // &str implements Clone
38 /// assert_eq!("Hello", hello.clone());
40 #[stable(feature = "rust1", since = "1.0.0")]
41 fn clone(&self) -> Self;
43 /// Performs copy-assignment from `source`.
45 /// `a.clone_from(&b)` is equivalent to `a = b.clone()` in functionality,
46 /// but can be overridden to reuse the resources of `a` to avoid unnecessary
49 #[stable(feature = "rust1", since = "1.0.0")]
50 fn clone_from(&mut self, source
: &Self) {
51 *self = source
.clone()
55 #[stable(feature = "rust1", since = "1.0.0")]
56 impl<'a
, T
: ?Sized
> Clone
for &'a T
{
57 /// Returns a shallow copy of the reference.
59 fn clone(&self) -> &'a T { *self }
62 macro_rules
! clone_impl
{
64 #[stable(feature = "rust1", since = "1.0.0")]
66 /// Returns a deep copy of the value.
68 fn clone(&self) -> $t { *self }