std::clone::Clone - Rust
Description: API documentation for the Rust `Clone` trait in crate `std`.
Keywords: rust, rustlang, rust-lang, Clone

# Trait std::clone::Clone 1.0.0 [−] [src]

    #[lang = "clone"]
    pub trait Clone {
        fn clone(&self) -> Self;

        fn clone_from(&mut self, source: &Self) { ... }
    }

A common trait for the ability to explicitly duplicate an object.

Differs from `Copy` in that `Copy` is implicit and extremely inexpensive, while `Clone` is always explicit and may or may not be expensive. In order to enforce these characteristics, Rust does not allow you to reimplement `Copy`, but you may reimplement `Clone` and run arbitrary code.

Since `Clone` is more general than `Copy`, you can automatically make anything `Copy` be `Clone` as well.

## Derivable

This trait can be used with `#[derive]` if all fields are `Clone`. The `derive`d implementation of `clone` calls `clone` on each field.

## How can I implement `Clone`?

Types that are `Copy` should have a trivial implementation of `Clone`. More formally: if `T: Copy`, `x: T`, and `y: &T`, then `let x = y.clone();` is equivalent to `let x = *y;`. Manual implementations should be careful to uphold this invariant; however, unsafe code must not rely on it to ensure memory safety.

An example is an array holding more than 32 elements of a type that is `Clone`; the standard library only implements `Clone` up until arrays of size 32. In this case, the implementation of `Clone` cannot be `derive`d, but can be implemented as:

    #[derive(Copy)]
    struct Stats {
       frequencies: [i32; 100],
    }

    impl Clone for Stats {
        fn clone(&self) -> Stats { *self }
    }Run

## Required Methods

### `fn clone(&self) -> Self`

Returns a copy of the value.

# Examples

    let hello = "Hello"; // &str implements Clone

    assert_eq!("Hello", hello.clone());Run

## Provided Methods

### `fn clone_from(&mut self, source: &Self)`

Performs copy-assignment from `source`.

`a.clone_from(&b)` is equivalent to `a = b.clone()` in functionality, but can be overridden to reuse the resources of `a` to avoid unnecessary allocations.

## Implementations on Foreign Types

### `impl<I> Clone for Utf16Encoder<I> where
I: Clone,`
[src]

#### `fn clone(&self) -> Utf16Encoder<I>`
[src]

#### `fn clone_from(&mut self, source: &Self)`
1.0.0
[src]

### `impl<T> Clone for NonZero<T> where
T: Zeroable + Clone,`
[src]

#### `fn clone(&self) -> NonZero<T>`
[src]

#### `fn clone_from(&mut self, source: &Self)`
1.0.0
[src]

## Implementors

- [src]
  `impl Clone for DecodeUtf16Error`
- [src]
  `impl Clone for UnicodeVersion`
- [src]
  `impl<I> Clone for DecodeUtf16<I> where
  I: Clone + Iterator<Item = u16>,`
- [src]
  `impl<'a> Clone for SplitWhitespace<'a>`
- [src]
  `impl Clone for std::sync::atomic::Ordering`
- [src]
  `impl Clone for Utf8Error`
- [src]
  `impl<I> Clone for Enumerate<I> where
  I: Clone,`
- [src]
  `impl<T> Clone for Cell<T> where
  T: Copy,`
- [src]
  `impl<'a, F> Clone for CharPredicateSearcher<'a, F> where
  F: Clone + FnMut(char) -> bool,`
- [src]
  `impl<'a, P> Clone for RMatchIndices<'a, P> where
  P: Pattern<'a>,
  <P as Pattern<'a>>::Searcher: Clone,`
- [src]
  `impl Clone for EscapeDefault`
- [src]
  `impl Clone for TypeId`
- [src]
  `impl Clone for SipHasher13`
- [src]
  `impl<A, B> Clone for Zip<A, B> where
  A: Clone,
  B: Clone,`
- [src]
  `impl<A, B> Clone for Chain<A, B> where
  A: Clone,
  B: Clone,`
- [src]
  `impl<I, F> Clone for Inspect<I, F> where
  F: Clone,
  I: Clone,`
- [src]
  `impl<'a, P> Clone for Matches<'a, P> where
  P: Pattern<'a>,
  <P as Pattern<'a>>::Searcher: Clone,`
- [src]
  `impl<I, F> Clone for Map<I, F> where
  F: Clone,
  I: Clone,`
- [src]
  `impl<'a, 'b> Clone for StrSearcher<'a, 'b>`
- [src]
  `impl Clone for CharTryFromError`
- [src]
  `impl<I> Clone for Peekable<I> where
  I: Clone + Iterator,
  <I as Iterator>::Item: Clone,`
- [src]
  `impl Clone for Infallible`
- [src]
  `impl Clone for TryFromIntError`
- [src]
  `impl<I> Clone for DecodeUtf8<I> where
  I: Clone + Iterator<Item = u8>,`
- [src]
  `impl<T> Clone for Discriminant<T>`
- [src]
  `impl Clone for NoneError`
- [src]
  `impl Clone for EscapeDebug`
- [src]
  `impl<I> Clone for Fuse<I> where
  I: Clone,`
- [src]
  `impl<Idx> Clone for std::ops::Range<Idx> where
  Idx: Clone,`
- [src]
  `impl<Idx> Clone for RangeTo<Idx> where
  Idx: Clone,`
- [src]
  `impl<'a, T> Clone for std::result::Iter<'a, T>`
- [src]
  `impl Clone for Error`
- [src]
  `impl<T> Clone for Once<T> where
  T: Clone,`
- [src]
  `impl<I, U, F> Clone for FlatMap<I, U, F> where
  F: Clone,
  I: Clone,
  U: Clone + IntoIterator,
  <U as IntoIterator>::IntoIter: Clone,
  <U as IntoIterator>::IntoIter: Clone,`
- [src]
  `impl<T> Clone for Wrapping<T> where
  T: Clone,`
- [src]
  `impl<T> Clone for PhantomData<T> where
  T: ?Sized,`
- [src]
  `impl<'a, T, P> Clone for std::slice::RSplit<'a, T, P> where
  P: Clone + FnMut(&T) -> bool,
  T: 'a + Clone,`
- [src]
  `impl Clone for ParseFloatError`
- [src]
  `impl Clone for SearchStep`
- [src]
  `impl<Idx> Clone for RangeFrom<Idx> where
  Idx: Clone,`
- [src]
  `impl<Idx> Clone for RangeInclusive<Idx> where
  Idx: Clone,`
- [src]
  `impl<I> Clone for Cycle<I> where
  I: Clone,`
- [src]
  `impl Clone for SipHasher`
- [src]
  `impl<'a> Clone for Arguments<'a>`
- [src]
  `impl Clone for TraitObject`
- [src]
  `impl<T> Clone for Shared<T> where
  T: ?Sized,`
- [src]
  `impl<'a, A> Clone for std::option::Iter<'a, A>`
- [src]
  `impl<'a, P> Clone for MatchIndices<'a, P> where
  P: Pattern<'a>,
  <P as Pattern<'a>>::Searcher: Clone,`
- [src]
  `impl<'a, T> Clone for Windows<'a, T>`
- [src]
  `impl<I, P> Clone for SkipWhile<I, P> where
  I: Clone,
  P: Clone,`
- [src]
  `impl<'a, P> Clone for SplitN<'a, P> where
  P: Pattern<'a>,
  <P as Pattern<'a>>::Searcher: Clone,`
- [src]
  `impl<'a, P> Clone for RSplitTerminator<'a, P> where
  P: Pattern<'a>,
  <P as Pattern<'a>>::Searcher: Clone,`
- [src]
  `impl<I, St, F> Clone for Scan<I, St, F> where
  F: Clone,
  I: Clone,
  St: Clone,`
- [src]
  `impl<I> Clone for Take<I> where
  I: Clone,`
- [src]
  `impl<'a> Clone for CharSearcher<'a>`
- [src]
  `impl<'a, 'b> Clone for CharSliceSearcher<'a, 'b>`
- [src]
  `impl<'a, P> Clone for RSplitN<'a, P> where
  P: Pattern<'a>,
  <P as Pattern<'a>>::Searcher: Clone,`
- [src]
  `impl<'a, T> Clone for std::slice::Iter<'a, T>`
- [src]
  `impl<I> Clone for StepBy<I> where
  I: Clone,`
- [src]
  `impl<I> Clone for Cloned<I> where
  I: Clone,`
- [src]
  `impl<I> Clone for Skip<I> where
  I: Clone,`
- [src]
  `impl<T> Clone for RefCell<T> where
  T: Clone,`
- [src]
  `impl<T> Clone for Empty<T>`
- [src]
  `impl Clone for EscapeUnicode`
- [src]
  `impl<'a, P> Clone for RMatches<'a, P> where
  P: Pattern<'a>,
  <P as Pattern<'a>>::Searcher: Clone,`
- [src]
  `impl<T> Clone for Rev<T> where
  T: Clone,`
- [src]
  `impl Clone for SipHasher24`
- [src]
  `impl Clone for ParseBoolError`
- [src]
  `impl<Idx> Clone for RangeToInclusive<Idx> where
  Idx: Clone,`
- [src]
  `impl<'a> Clone for CharIndices<'a>`
- [src]
  `impl<'a> Clone for Lines<'a>`
- [src]
  `impl<A> Clone for Repeat<A> where
  A: Clone,`
- [src]
  `impl<H> Clone for BuildHasherDefault<H>`
- [src]
  `impl<'a, P> Clone for std::str::Split<'a, P> where
  P: Pattern<'a>,
  <P as Pattern<'a>>::Searcher: Clone,`
- [src]
  `impl<T, E> Clone for Result<T, E> where
  E: Clone,
  T: Clone,`
- [src]
  `impl<'a> Clone for Bytes<'a>`
- [src]
  `impl Clone for ParseIntError`
- [src]
  `impl<T> Clone for ManuallyDrop<T> where
  T: Clone,`
- [src]
  `impl<'a, P> Clone for std::str::RSplit<'a, P> where
  P: Pattern<'a>,
  <P as Pattern<'a>>::Searcher: Clone,`
- [src]
  `impl<T> Clone for Option<T> where
  T: Clone,`
- [src]
  `impl<Y, R> Clone for GeneratorState<Y, R> where
  R: Clone,
  Y: Clone,`
- [src]
  `impl<'a, P> Clone for SplitTerminator<'a, P> where
  P: Pattern<'a>,
  <P as Pattern<'a>>::Searcher: Clone,`
- [src]
  `impl<'a> Clone for Chars<'a>`
- [src]
  `impl<'a> Clone for LinesAny<'a>`
- [src]
  `impl<I, P> Clone for Filter<I, P> where
  I: Clone,
  P: Clone,`
- [src]
  `impl<I, P> Clone for TakeWhile<I, P> where
  I: Clone,
  P: Clone,`
- [src]
  `impl Clone for RangeFull`
- [src]
  `impl<'a, T> Clone for Chunks<'a, T>`
- [src]
  `impl<I, F> Clone for FilterMap<I, F> where
  F: Clone,
  I: Clone,`
- [src]
  `impl<T> Clone for Unique<T> where
  T: ?Sized,`
- [src]
  `impl Clone for ParseCharError`
- [src]
  `impl Clone for FpCategory`
- [src]
  `impl<'a, T, P> Clone for std::slice::Split<'a, T, P> where
  P: Clone + FnMut(&T) -> bool,`
- [src]
  `impl Clone for std::cmp::Ordering`
- [src]
  `impl<A> Clone for std::option::IntoIter<A> where
  A: Clone,`
- [src]
  `impl<'a, K, V> Clone for std::collections::btree_map::Range<'a, K, V>`
- [src]
  `impl<'a, T> Clone for std::collections::btree_set::Intersection<'a, T>`
- [src]
  `impl<T> Clone for std::collections::linked_list::IntoIter<T> where
  T: Clone,`
- [src]
  `impl<'a, T> Clone for std::collections::btree_set::SymmetricDifference<'a, T>`
- [src]
  `impl<T> Clone for LinkedList<T> where
  T: Clone,`
- [src]
  `impl<K, V> Clone for BTreeMap<K, V> where
  K: Clone,
  V: Clone,`
- [src]
  `impl Clone for Layout`
- [src]
  `impl<T> Clone for std::sync::Weak<T> where
  T: ?Sized,`
- [src]
  `impl<T> Clone for std::collections::vec_deque::IntoIter<T> where
  T: Clone,`
- [src]
  `impl<'a, T> Clone for std::collections::btree_set::Union<'a, T>`
- [src]
  `impl<T> Clone for std::rc::Weak<T> where
  T: ?Sized,`
- [src]
  `impl<T> Clone for Box<[T]> where
  T: Clone,`
- [src]
  `impl<T> Clone for Box<T> where
  T: Clone,`
- [src]
  `impl<'a, T> Clone for std::collections::btree_set::Iter<'a, T>`
- [src]
  `impl<'a, T> Clone for std::collections::linked_list::Iter<'a, T>`
- [src]
  `impl<'a> Clone for EncodeUtf16<'a>`
- [src]
  `impl<T> Clone for Bound<T> where
  T: Clone,`
- [src]
  `impl<'a, T> Clone for std::collections::btree_set::Range<'a, T>`
- [src]
  `impl<'a, T> Clone for std::collections::vec_deque::Iter<'a, T>`
- [src]
  `impl Clone for Heap`
- [src]
  `impl<T> Clone for BTreeSet<T> where
  T: Clone,`
- [src]
  `impl Clone for String`
- [src]
  `impl<'a, K, V> Clone for std::collections::btree_map::Keys<'a, K, V>`
- [src]
  `impl<'a, T> Clone for std::collections::btree_set::Difference<'a, T>`
- [src]
  `impl<T> Clone for std::vec::IntoIter<T> where
  T: Clone,`
- [src]
  `impl<'a, T> Clone for std::collections::binary_heap::Iter<'a, T>`
- [src]
  `impl<'a, B> Clone for Cow<'a, B> where
  B: ToOwned + ?Sized,`
- [src]
  `impl<T> Clone for std::collections::binary_heap::IntoIter<T> where
  T: Clone,`
- [src]
  `impl<T> Clone for Vec<T> where
  T: Clone,`
- [src]
  `impl<T> Clone for BinaryHeap<T> where
  T: Clone,`
- [src]
  `impl<T> Clone for Arc<T> where
  T: ?Sized,`
- [src]
  `impl<T> Clone for VecDeque<T> where
  T: Clone,`
- [src]
  `impl<T> Clone for Rc<T> where
  T: ?Sized,`
- [src]
  `impl<'a, K, V> Clone for std::collections::btree_map::Values<'a, K, V>`
- [src]
  `impl Clone for Box<str>`
- [src]
  `impl Clone for AllocErr`
- [src]
  `impl<'a, K, V> Clone for std::collections::btree_map::Iter<'a, K, V>`
- [src]
  `impl Clone for CannotReallocInPlace`
- [src]
  `impl Clone for ParseError`
- [src]
  `impl Clone for ExchangeHeapSingleton`
- [src]
  `impl Clone for LocalKeyState`
- [src]
  `impl Clone for ThreadId`
- [src]
  `impl Clone for Thread`
- [src]
  `impl<K: Clone, V: Clone, S: Clone> Clone for HashMap<K, V, S>`
- [src]
  `impl<'a, K, V> Clone for std::collections::hash_map::Iter<'a, K, V>`
- [src]
  `impl<'a, K, V> Clone for std::collections::hash_map::Keys<'a, K, V>`
- [src]
  `impl<'a, K, V> Clone for std::collections::hash_map::Values<'a, K, V>`
- [src]
  `impl Clone for RandomState`
- [src]
  `impl Clone for DefaultHasher`
- [src]
  `impl<T: Clone, S: Clone> Clone for HashSet<T, S>`
- [src]
  `impl<'a, K> Clone for std::collections::hash_set::Iter<'a, K>`
- [src]
  `impl<'a, T, S> Clone for std::collections::hash_set::Intersection<'a, T, S>`
- [src]
  `impl<'a, T, S> Clone for std::collections::hash_set::Difference<'a, T, S>`
- [src]
  `impl<'a, T, S> Clone for std::collections::hash_set::SymmetricDifference<'a, T, S>`
- [src]
  `impl<'a, T, S> Clone for std::collections::hash_set::Union<'a, T, S>`
- [src]
  `impl Clone for VarError`
- [src]
  `impl Clone for CString`
- [src]
  `impl Clone for NulError`
- [src]
  `impl Clone for FromBytesWithNulError`
- [src]
  `impl Clone for IntoStringError`
- [src]
  `impl Clone for OsString`
- [src]
  `impl Clone for Metadata`
- [src]
  `impl Clone for OpenOptions`
- [src]
  `impl Clone for Permissions`
- [src]
  `impl Clone for FileType`
- [src]
  `impl<T: Clone> Clone for Cursor<T>`
- [src]
  `impl Clone for ErrorKind`
- [src]
  `impl Clone for SeekFrom`
- [src]
  `impl Clone for IpAddr`
- [src]
  `impl Clone for Ipv6MulticastScope`
- [src]
  `impl Clone for Ipv4Addr`
- [src]
  `impl Clone for Ipv6Addr`
- [src]
  `impl Clone for std::net::SocketAddr`
- [src]
  `impl Clone for SocketAddrV4`
- [src]
  `impl Clone for SocketAddrV6`
- [src]
  `impl Clone for AddrParseError`
- [src]
  `impl Clone for Shutdown`
- [src]
  `impl Clone for stat`
- [src]
  `impl<'a> Clone for Prefix<'a>`
- [src]
  `impl<'a> Clone for PrefixComponent<'a>`
- [src]
  `impl<'a> Clone for Component<'a>`
- [src]
  `impl<'a> Clone for Components<'a>`
- [src]
  `impl<'a> Clone for std::path::Iter<'a>`
- [src]
  `impl Clone for PathBuf`
- [src]
  `impl Clone for StripPrefixError`
- [src]
  `impl Clone for Output`
- [src]
  `impl Clone for ExitStatus`
- [src]
  `impl<T: Clone> Clone for SendError<T>`
- [src]
  `impl Clone for RecvError`
- [src]
  `impl Clone for TryRecvError`
- [src]
  `impl Clone for RecvTimeoutError`
- [src]
  `impl<T: Clone> Clone for TrySendError<T>`
- [src]
  `impl<T> Clone for Sender<T>`
- [src]
  `impl<T> Clone for SyncSender<T>`
- [src]
  `impl Clone for WaitTimeoutResult`
- [src]
  `impl Clone for Duration`
- [src]
  `impl Clone for Instant`
- [src]
  `impl Clone for SystemTime`
- [src]
  `impl Clone for SystemTimeError`
- [src]
  `impl<'a> Clone for EncodeWide<'a>`
- [src]
  `impl Clone for std::os::unix::net::SocketAddr`

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)