1.0.0[][src]Trait no_std_compat::clone::Clone

#[lang = "clone"]pub trait Clone {
#[must_use =
  "cloning is often expensive and is not expected to have side effects"]    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 derived implementation of clone calls clone on each field.

For a generic struct, #[derive] implements Clone conditionally by adding bound Clone on generic parameters.

// `derive` implements Clone for Reading<T> when T is Clone.
#[derive(Clone)]
struct Reading<T> {
    frequency: T,
}

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 a generic struct holding a function pointer. In this case, the implementation of Clone cannot be derived, but can be implemented as:

struct Generate<T>(fn() -> T);

impl<T> Copy for Generate<T> {}

impl<T> Clone for Generate<T> {
    fn clone(&self) -> Self {
        *self
    }
}

Additional implementors

In addition to the implementors listed below, the following types also implement Clone:

  • Function item types (i.e., the distinct types defined for each function)
  • Function pointer types (e.g., fn() -> i32)
  • Array types, for all sizes, if the item type also implements Clone (e.g., [i32; 123456])
  • Tuple types, if each component also implements Clone (e.g., (), (i32, bool))
  • Closure types, if they capture no value from the environment or if all such captured values implement Clone themselves. Note that variables captured by shared reference always implement Clone (even if the referent doesn't), while variables captured by mutable reference never implement Clone.

Required methods

#[must_use = "cloning is often expensive and is not expected to have side effects"]fn clone(&self) -> Self

Returns a copy of the value.

Examples

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

assert_eq!("Hello", hello.clone());
Loading content...

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.

Loading content...

Implementations on Foreign Types

impl<T> Clone for OnceCell<T> where
    T: Clone
[src]

impl Clone for TraitObject[src]

Loading content...

Implementors

impl Clone for RangeFull[src]

impl Clone for no_std_compat::sync::atomic::Ordering[src]

impl Clone for ToUppercase[src]

impl Clone for PhantomPinned[src]

impl Clone for AllocErr[src]

impl Clone for Duration[src]

impl Clone for no_std_compat::cmp::Ordering[src]

impl Clone for NonZeroUsize[src]

impl Clone for TryFromIntError[src]

impl Clone for SipHasher[src]

impl Clone for bool[src]

impl Clone for NoneError[src]

impl Clone for SearchStep[src]

impl Clone for ParseBoolError[src]

impl Clone for ToLowercase[src]

impl Clone for no_std_compat::char::EscapeDefault[src]

impl Clone for NonZeroIsize[src]

impl Clone for CharTryFromError[src]

impl Clone for Infallible[src]

impl Clone for AllocInit[src]

impl Clone for LayoutErr[src]

impl Clone for Error[src]

impl Clone for ParseFloatError[src]

impl Clone for no_std_compat::char::EscapeUnicode[src]

impl Clone for ReallocPlacement[src]

impl Clone for Waker[src]

impl Clone for no_std_compat::ascii::EscapeDefault[src]

impl Clone for IntErrorKind[src]

impl Clone for RawWakerVTable[src]

impl Clone for TypeId[src]

impl Clone for no_std_compat::char::EscapeDebug[src]

impl Clone for TryFromSliceError[src]

impl Clone for FpCategory[src]

impl Clone for ParseIntError[src]

impl Clone for ![src]

impl Clone for ParseCharError[src]

impl Clone for isize[src]

impl Clone for usize[src]

impl Clone for MemoryBlock[src]

impl Clone for Layout[src]

impl Clone for char[src]

impl Clone for CpuidResult[src]

impl Clone for __m128[src]

impl Clone for __m128d[src]

impl Clone for __m128i[src]

impl Clone for __m256[src]

impl Clone for __m256d[src]

impl Clone for __m256i[src]

impl Clone for __m512[src]

impl Clone for __m512d[src]

impl Clone for __m512i[src]

impl Clone for __m64[src]

impl Clone for DecodeUtf16Error[src]

impl Clone for NonZeroI128[src]

impl Clone for NonZeroI16[src]

impl Clone for NonZeroI32[src]

impl Clone for NonZeroI64[src]

impl Clone for NonZeroI8[src]

impl Clone for NonZeroU128[src]

impl Clone for NonZeroU16[src]

impl Clone for NonZeroU32[src]

impl Clone for NonZeroU64[src]

impl Clone for NonZeroU8[src]

impl Clone for Utf8Error[src]

impl Clone for f32[src]

impl Clone for f64[src]

impl Clone for i8[src]

impl Clone for i16[src]

impl Clone for i32[src]

impl Clone for i64[src]

impl Clone for i128[src]

impl Clone for u8[src]

impl Clone for u16[src]

impl Clone for u32[src]

impl Clone for u64[src]

impl Clone for u128[src]

impl<'_, A> Clone for no_std_compat::option::Iter<'_, A>[src]

impl<'_, T> !Clone for &'_ mut T where
    T: ?Sized
[src]

Shared references can be cloned, but mutable references cannot!

impl<'_, T> Clone for Chunks<'_, T>[src]

impl<'_, T> Clone for no_std_compat::result::Iter<'_, T>[src]

impl<'_, T> Clone for Windows<'_, T>[src]

impl<'_, T> Clone for ChunksExact<'_, T>[src]

impl<'_, T> Clone for no_std_compat::slice::Iter<'_, T>[src]

impl<'_, T> Clone for RChunks<'_, T>[src]

impl<'_, T> Clone for &'_ T where
    T: ?Sized
[src]

Shared references can be cloned, but mutable references cannot!

impl<'_, T, P> Clone for no_std_compat::slice::Split<'_, T, P> where
    P: Clone + FnMut(&T) -> bool, 
[src]

impl<'_, T, P> Clone for no_std_compat::slice::SplitInclusive<'_, T, P> where
    P: Clone + FnMut(&T) -> bool, 
[src]

impl<'a> Clone for CharSearcher<'a>[src]

impl<'a> Clone for Chars<'a>[src]

impl<'a> Clone for no_std_compat::str::EscapeUnicode<'a>[src]

impl<'a> Clone for SplitAsciiWhitespace<'a>[src]

impl<'a> Clone for SplitWhitespace<'a>[src]

impl<'a> Clone for CharIndices<'a>[src]

impl<'a> Clone for Bytes<'a>[src]

impl<'a> Clone for Arguments<'a>[src]

impl<'a> Clone for LinesAny<'a>[src]

impl<'a> Clone for no_std_compat::str::EscapeDefault<'a>[src]

impl<'a> Clone for Lines<'a>[src]

impl<'a> Clone for no_std_compat::str::EscapeDebug<'a>[src]

impl<'a> Clone for EncodeUtf16<'a>[src]

impl<'a, 'b> Clone for CharSliceSearcher<'a, 'b>[src]

impl<'a, 'b> Clone for StrSearcher<'a, 'b>[src]

impl<'a, F> Clone for CharPredicateSearcher<'a, F> where
    F: Clone + FnMut(char) -> bool, 
[src]

impl<'a, P> Clone for MatchIndices<'a, P> where
    P: Pattern<'a>,
    <P as Pattern<'a>>::Searcher: Clone
[src]

impl<'a, P> Clone for Matches<'a, P> where
    P: Pattern<'a>,
    <P as Pattern<'a>>::Searcher: Clone
[src]

impl<'a, P> Clone for RMatchIndices<'a, P> where
    P: Pattern<'a>,
    <P as Pattern<'a>>::Searcher: Clone
[src]

impl<'a, P> Clone for RMatches<'a, P> where
    P: Pattern<'a>,
    <P as Pattern<'a>>::Searcher: Clone
[src]

impl<'a, P> Clone for no_std_compat::str::RSplit<'a, P> where
    P: Pattern<'a>,
    <P as Pattern<'a>>::Searcher: Clone
[src]

impl<'a, P> Clone for RSplitN<'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<'a, P> Clone for no_std_compat::str::Split<'a, P> where
    P: Pattern<'a>,
    <P as Pattern<'a>>::Searcher: Clone
[src]

impl<'a, P> Clone for no_std_compat::str::SplitInclusive<'a, P> where
    P: Pattern<'a>,
    <P as Pattern<'a>>::Searcher: 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 SplitTerminator<'a, P> where
    P: Pattern<'a>,
    <P as Pattern<'a>>::Searcher: Clone
[src]

impl<'a, T> Clone for RChunksExact<'a, T>[src]

impl<'a, T, P> Clone for no_std_compat::slice::RSplit<'a, T, P> where
    P: Clone + FnMut(&T) -> bool,
    T: 'a + Clone
[src]

impl<'f> Clone for VaListImpl<'f>[src]

impl<A> Clone for Repeat<A> where
    A: Clone
[src]

impl<A> Clone for no_std_compat::option::IntoIter<A> where
    A: Clone
[src]

impl<A, B> Clone for Chain<A, B> where
    A: Clone,
    B: Clone
[src]

impl<A, B> Clone for Zip<A, B> where
    A: Clone,
    B: Clone
[src]

impl<F> Clone for FromFn<F> where
    F: Clone
[src]

impl<F> Clone for OnceWith<F> where
    F: Clone
[src]

impl<F> Clone for RepeatWith<F> where
    F: Clone
[src]

impl<H> Clone for BuildHasherDefault<H>[src]

impl<I> Clone for DecodeUtf16<I> where
    I: Clone + Iterator<Item = u16>, 
[src]

impl<I> Clone for Cloned<I> where
    I: Clone
[src]

impl<I> Clone for Copied<I> where
    I: Clone
[src]

impl<I> Clone for Cycle<I> where
    I: Clone
[src]

impl<I> Clone for Enumerate<I> where
    I: Clone
[src]

impl<I> Clone for Fuse<I> where
    I: Clone
[src]

impl<I> Clone for Peekable<I> where
    I: Clone + Iterator,
    <I as Iterator>::Item: Clone
[src]

impl<I> Clone for Skip<I> where
    I: Clone
[src]

impl<I> Clone for StepBy<I> where
    I: Clone
[src]

impl<I> Clone for Take<I> where
    I: Clone
[src]

impl<I, F> Clone for FilterMap<I, F> where
    F: Clone,
    I: Clone
[src]

impl<I, F> Clone for Inspect<I, F> where
    F: Clone,
    I: Clone
[src]

impl<I, F> Clone for Map<I, F> where
    F: Clone,
    I: Clone
[src]

impl<I, P> Clone for Filter<I, P> where
    I: Clone,
    P: Clone
[src]

impl<I, P> Clone for MapWhile<I, P> where
    I: Clone,
    P: Clone
[src]

impl<I, P> Clone for SkipWhile<I, P> where
    I: Clone,
    P: Clone
[src]

impl<I, P> Clone for TakeWhile<I, P> where
    I: Clone,
    P: Clone
[src]

impl<I, St, F> Clone for Scan<I, St, F> where
    F: Clone,
    I: Clone,
    St: Clone
[src]

impl<I, U> Clone for Flatten<I> where
    I: Clone + Iterator,
    U: Clone + Iterator,
    <I as Iterator>::Item: IntoIterator,
    <<I as Iterator>::Item as IntoIterator>::IntoIter == U,
    <<I as Iterator>::Item as IntoIterator>::Item == <U as Iterator>::Item
[src]

impl<I, U, F> Clone for FlatMap<I, U, F> where
    F: Clone,
    I: Clone,
    U: Clone + IntoIterator,
    <U as IntoIterator>::IntoIter: Clone
[src]

impl<Idx> Clone for Range<Idx> where
    Idx: Clone
[src]

impl<Idx> Clone for RangeFrom<Idx> where
    Idx: Clone
[src]

impl<Idx> Clone for RangeInclusive<Idx> where
    Idx: Clone
[src]

impl<Idx> Clone for RangeTo<Idx> where
    Idx: Clone
[src]

impl<Idx> Clone for RangeToInclusive<Idx> where
    Idx: Clone
[src]

impl<P> Clone for Pin<P> where
    P: Clone
[src]

impl<T> Clone for Pending<T>[src]

impl<T> Clone for Discriminant<T>[src]

impl<T> Clone for Empty<T>[src]

impl<T> Clone for *const T where
    T: ?Sized
[src]

impl<T> Clone for *mut T where
    T: ?Sized
[src]

impl<T> Clone for Bound<T> where
    T: Clone
[src]

impl<T> Clone for Option<T> where
    T: Clone
[src]

impl<T> Clone for Poll<T> where
    T: Clone
[src]

impl<T> Clone for Cell<T> where
    T: Copy
[src]

impl<T> Clone for RefCell<T> where
    T: Clone
[src]

fn clone(&self) -> RefCell<T>[src]

Panics

Panics if the value is currently mutably borrowed.

impl<T> Clone for Reverse<T> where
    T: Clone
[src]

impl<T> Clone for Ready<T> where
    T: Clone
[src]

impl<T> Clone for Once<T> where
    T: Clone
[src]

impl<T> Clone for Rev<T> where
    T: Clone
[src]

impl<T> Clone for PhantomData<T> where
    T: ?Sized
[src]

impl<T> Clone for ManuallyDrop<T> where
    T: Clone + ?Sized
[src]

impl<T> Clone for Wrapping<T> where
    T: Clone
[src]

impl<T> Clone for NonNull<T> where
    T: ?Sized
[src]

impl<T> Clone for no_std_compat::result::IntoIter<T> where
    T: Clone
[src]

impl<T> Clone for MaybeUninit<T> where
    T: Copy
[src]

impl<T, E> Clone for Result<T, E> where
    E: Clone,
    T: Clone
[src]

impl<T, F> Clone for Successors<T, F> where
    F: Clone,
    T: Clone
[src]

impl<Y, R> Clone for GeneratorState<Y, R> where
    R: Clone,
    Y: Clone
[src]

impl<const N: usize, T> Clone for no_std_compat::array::IntoIter<T, N> where
    T: Clone
[src]

Loading content...