Trait origin_studio::std::clone::Clone

1.0.0 · source ·

pub trait Clone: Sized {
    // Required method
    fn clone(&self) -> Self;

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

Expand description

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

Differs from Copy in that Copy is implicit and an inexpensive bit-wise copy, 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
    }
}

If we derive:

#[derive(Copy, Clone)]
struct Generate<T>(fn() -> T);

the auto-derived implementations will have unnecessary T: Copy and T: Clone bounds:


// Automatically derived
impl<T: Copy> Copy for Generate<T> { }

// Automatically derived
impl<T: Clone> Clone for Generate<T> {
    fn clone(&self) -> Generate<T> {
        Generate(Clone::clone(&self.0))
    }
}

The bounds are unnecessary because clearly the function itself should be copy- and cloneable even if its return type is not:

#[derive(Copy, Clone)]
struct Generate<T>(fn() -> T);

struct NotCloneable;

fn generate_not_cloneable() -> NotCloneable {
    NotCloneable
}

Generate(generate_not_cloneable).clone(); // error: trait bounds were not satisfied
// Note: With the manual implementations the above line will compile.

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)
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§

source

fn clone(&self) -> Self

Returns a copy of the value.

Examples

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

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

Provided Methods§

source

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.

Trait origin_studio::std::clone::Clone

Required Methods§

fn clone(&self) -> Self

Provided Methods§

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

Implementors§

impl Clone for AsciiChar

impl Clone for origin_studio::std::cmp::Ordering

impl Clone for TryReserveErrorKind

impl Clone for Infallible

impl Clone for VarError

impl Clone for origin_studio::std::fmt::Alignment

impl Clone for IpAddr

impl Clone for Ipv6MulticastScope

impl Clone for SocketAddr

impl Clone for FpCategory

impl Clone for IntErrorKind

impl Clone for Which

impl Clone for SearchStep

impl Clone for origin_studio::std::sync::atomic::Ordering

impl Clone for rustix::backend::fs::types::Advice

impl Clone for FileType

impl Clone for FlockOperation

impl Clone for rustix::backend::mm::types::Advice

impl Clone for MembarrierCommand

impl Clone for Resource

impl Clone for FutexOperation

impl Clone for TimerfdClockId

impl Clone for ClockId

impl Clone for SeekFrom

impl Clone for Direction

impl Clone for DumpableBehavior

impl Clone for EndianMode

impl Clone for FloatingPointMode

impl Clone for MachineCheckMemoryCorruptionKillPolicy

impl Clone for PTracer

impl Clone for SpeculationFeature

impl Clone for TimeStampCounterReadability

impl Clone for TimingMethod

impl Clone for VirtualMemoryMapAddress

impl Clone for Signal

impl Clone for NanosleepRelativeResult

impl Clone for Capability

impl Clone for CoreSchedulingScope

impl Clone for SecureComputingMode

impl Clone for SysCallUserDispatchFastSwitch

impl Clone for LinkNameSpaceType

impl Clone for bool

impl Clone for char

impl Clone for f32

impl Clone for f64

impl Clone for i8

impl Clone for i16

impl Clone for i32

impl Clone for i64

impl Clone for i128

impl Clone for isize

impl Clone for !

impl Clone for u8

impl Clone for u16

impl Clone for u32

impl Clone for u64

impl Clone for u128

impl Clone for usize

impl Clone for AllocError

impl Clone for Global

impl Clone for Layout

impl Clone for LayoutError

impl Clone for TypeId

impl Clone for CpuidResult

impl Clone for __m128

impl Clone for __m128bh

impl Clone for __m128d

impl Clone for __m128i

impl Clone for __m256

impl Clone for __m256bh

impl Clone for __m256d

impl Clone for __m256i

impl Clone for __m512

impl Clone for __m512bh