1.0.0[][src]Trait scale_info::prelude::marker::Copy

#[lang = "copy"]pub trait Copy: Clone { }

Types whose values can be duplicated simply by copying bits.

By default, variable bindings have 'move semantics.' In other words:

#[derive(Debug)]
struct Foo;

let x = Foo;

let y = x;

// `x` has moved into `y`, and so cannot be used

// println!("{:?}", x); // error: use of moved value

However, if a type implements Copy, it instead has 'copy semantics':

// We can derive a `Copy` implementation. `Clone` is also required, as it's
// a supertrait of `Copy`.
#[derive(Debug, Copy, Clone)]
struct Foo;

let x = Foo;

let y = x;

// `y` is a copy of `x`

println!("{:?}", x); // A-OK!

It's important to note that in these two examples, the only difference is whether you are allowed to access x after the assignment. Under the hood, both a copy and a move can result in bits being copied in memory, although this is sometimes optimized away.

How can I implement Copy?

There are two ways to implement Copy on your type. The simplest is to use derive:

#[derive(Copy, Clone)]
struct MyStruct;

You can also implement Copy and Clone manually:

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.

What's the difference between Copy and Clone?

Copies happen implicitly, for example as part of an assignment y = x. The behavior of Copy is not overloadable; it is always a simple bit-wise copy.

Cloning is an explicit action, x.clone(). The implementation of Clone can provide any type-specific behavior necessary to duplicate values safely. For example, the implementation of Clone for String needs to copy the pointed-to string buffer in the heap. A simple bitwise copy of String values would merely copy the pointer, leading to a double free down the line. For this reason, String is Clone but not Copy.

Clone is a supertrait of Copy, so everything which is Copy must also implement Clone. If a type is Copy then its Clone implementation only needs to return *self (see the example above).

When can my type be Copy?

A type can implement Copy if all of its components implement Copy. For example, this struct can be Copy:

#[derive(Copy, Clone)]
struct Point {
   x: i32,
   y: i32,
}

A struct can be Copy, and i32 is Copy, therefore Point is eligible to be Copy. By contrast, consider

struct PointList {
    points: Vec<Point>,
}

The struct PointList cannot implement Copy, because Vec<T> is not Copy. If we attempt to derive a Copy implementation, we'll get an error:

the trait `Copy` may not be implemented for this type; field `points` does not implement `Copy`

Shared references (&T) are also Copy, so a type can be Copy, even when it holds shared references of types T that are not Copy. Consider the following struct, which can implement Copy, because it only holds a shared reference to our non-Copy type PointList from above:

#[derive(Copy, Clone)]
struct PointListWrapper<'a> {
    point_list_ref: &'a PointList,
}

When can't my type be Copy?

Some types can't be copied safely. For example, copying &mut T would create an aliased mutable reference. Copying String would duplicate responsibility for managing the String's buffer, leading to a double free.

Generalizing the latter case, any type implementing Drop can't be Copy, because it's managing some resource besides its own size_of::<T> bytes.

If you try to implement Copy on a struct or enum containing non-Copy data, you will get the error E0204.

When should my type be Copy?

Generally speaking, if your type can implement Copy, it should. Keep in mind, though, that implementing Copy is part of the public API of your type. If the type might become non-Copy in the future, it could be prudent to omit the Copy implementation now, to avoid a breaking API change.

Additional implementors

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

  • 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 Copy (e.g., [i32; 123456])
  • Tuple types, if each component also implements Copy (e.g., (), (i32, bool))
  • Closure types, if they capture no value from the environment or if all such captured values implement Copy themselves. Note that variables captured by shared reference always implement Copy (even if the referent doesn't), while variables captured by mutable reference never implement Copy.

Implementations on Foreign Types

impl Copy for AccessError[src]

impl<T> Copy for TrySendError<T> where
    T: Copy
[src]

impl Copy for Instant[src]

impl Copy for ThreadId[src]

impl Copy for Ipv6MulticastScope[src]

impl<'a> Copy for Ancestors<'a>[src]

impl<'a> Copy for IoSlice<'a>[src]

impl Copy for ExitStatus[src]

impl Copy for ExitCode[src]

impl Copy for SocketAddr[src]

impl<'a> Copy for PrefixComponent<'a>[src]

impl<T> Copy for SendError<T> where
    T: Copy
[src]

impl Copy for RecvTimeoutError[src]

impl Copy for SystemTime[src]

impl Copy for RecvError[src]

impl Copy for SeekFrom[src]

impl Copy for SocketAddrV4[src]

impl Copy for SocketAddrV6[src]

impl Copy for ErrorKind[src]

impl<'a> Copy for Component<'a>[src]

impl Copy for System[src]

impl Copy for Ipv6Addr[src]

impl Copy for TryRecvError[src]

impl Copy for Shutdown[src]

impl Copy for Ipv4Addr[src]

impl Copy for IpAddr[src]

impl Copy for WaitTimeoutResult[src]

impl<'a> Copy for Prefix<'a>[src]

impl Copy for FileType[src]

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

impl<'a, T, const N: usize> Copy for ArrayWindows<'a, T, N> where
    T: 'a + Copy
[src]

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

impl Copy for SearchStep[src]

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

impl Copy for Ordering[src]

impl Copy for __m256i[src]

impl Copy for AllocError[src]

impl Copy for __m128i[src]

impl Copy for char[src]

impl Copy for i64[src]

impl Copy for f64[src]

impl Copy for CharTryFromError[src]

impl Copy for Layout[src]

impl Copy for i32[src]

impl Copy for RangeFull[src]

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

Shared references can be copied, but mutable references cannot!

impl Copy for u16[src]

impl Copy for TryFromSliceError[src]

impl Copy for Infallible[src]

impl Copy for Duration[src]

impl Copy for bool[src]

impl Copy for u8[src]

impl Copy for i128[src]

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

impl Copy for NoneError[src]

impl Copy for isize[src]

impl<'a> Copy for Location<'a>[src]

impl Copy for TraitObject[src]

impl Copy for __m256d[src]

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

impl Copy for i16[src]

impl Copy for __m128d[src]

impl Copy for u64[src]

impl Copy for Utf8Error[src]

impl Copy for __m512[src]

impl Copy for u32[src]

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

impl Copy for i8[src]

impl Copy for usize[src]

impl Copy for RawWakerVTable[src]

impl Copy for __m512i[src]

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

impl Copy for __m512d[src]

impl Copy for u128[src]

impl<B, C> Copy for ControlFlow<B, C> where
    C: Copy,
    B: Copy
[src]

impl Copy for ![src]

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

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

impl Copy for __m256[src]

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

impl Copy for f32[src]

impl Copy for __m128[src]

impl Copy for CpuidResult[src]

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

impl Copy for Global[src]

impl Copy for OptionBool[src]

impl<T> Copy for Compact<T> where
    T: Copy
[src]

impl<T> Copy for CapacityError<T> where
    T: Copy
[src]

impl<A> Copy for ArrayString<A> where
    A: Copy + Array<Item = u8>,
    <A as Array>::Index: Copy
[src]

impl<E> Copy for CharDeserializer<E>[src]

impl<E> Copy for F64Deserializer<E>[src]

impl<E> Copy for I64Deserializer<E>[src]

impl<'a, E> Copy for BytesDeserializer<'a, E>[src]

impl<E> Copy for I16Deserializer<E>[src]

impl<E> Copy for U128Deserializer<E>[src]

impl<E> Copy for UsizeDeserializer<E>[src]

impl<E> Copy for F32Deserializer<E>[src]

impl<E> Copy for BoolDeserializer<E>[src]

impl<'de, E> Copy for BorrowedBytesDeserializer<'de, E>[src]

impl Copy for IgnoredAny[src]

impl<'de, E> Copy for StrDeserializer<'de, E>[src]

impl<E> Copy for U32Deserializer<E>[src]

impl<E> Copy for IsizeDeserializer<E>[src]

impl<E> Copy for U16Deserializer<E>[src]

impl<'de, E> Copy for BorrowedStrDeserializer<'de, E>[src]

impl<E> Copy for I8Deserializer<E>[src]

impl<E> Copy for I32Deserializer<E>[src]

impl<'a> Copy for Unexpected<'a>[src]

impl<E> Copy for U64Deserializer<E>[src]

impl<E> Copy for U8Deserializer<E>[src]

impl<E> Copy for UnitDeserializer<E>[src]

impl<E> Copy for I128Deserializer<E>[src]

Loading content...

Implementors

impl Copy for MetaForm[src]

impl Copy for scale_info::prelude::cmp::Ordering[src]

impl Copy for FpCategory[src]

impl Copy for TypeId[src]

impl Copy for Error[src]

impl Copy for PhantomPinned1.33.0[src]

impl Copy for NonZeroI81.34.0[src]

impl Copy for NonZeroI161.34.0[src]

impl Copy for NonZeroI321.34.0[src]

impl Copy for NonZeroI641.34.0[src]

impl Copy for NonZeroI1281.34.0[src]

impl Copy for NonZeroIsize1.34.0[src]

impl Copy for NonZeroU81.28.0[src]

impl Copy for NonZeroU161.28.0[src]

impl Copy for NonZeroU321.28.0[src]

impl Copy for NonZeroU641.28.0[src]

impl Copy for NonZeroU1281.28.0[src]

impl Copy for NonZeroUsize1.28.0[src]

impl Copy for TryFromIntError1.34.0[src]

impl Copy for MetaType[src]

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

impl<'a, T: Copy> Copy for Symbol<'a, T>[src]

impl<S: Copy> Copy for PortableForm<S>[src]

impl<T> Copy for Bound<T> where
    T: Copy
1.17.0[src]

impl<T> Copy for Reverse<T> where
    T: Copy
1.19.0[src]

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

impl<T> Copy for Discriminant<T>1.21.0[src]

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

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

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

impl<T: Copy> Copy for UntrackedSymbol<T>[src]

Loading content...