Trait kvarn::prelude::utils::prelude::compact_str::core::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) { ... }
}

Available on non-crate feature miri-test-libstd only.

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.

Object Safety§

This trait is not object safe.

Trait kvarn::prelude::utils::prelude::compact_str::core::clone::Clone

§Derivable

§How can I implement Clone?

§Additional implementors

Required Methods§

fn clone(&self) -> Self

§Examples

Provided Methods§

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

Object Safety§

Implementors§

impl Clone for CachePreferenceError

impl Clone for ClientCachePreference

impl Clone for CompressPreference

impl Clone for PreferredCompression

impl Clone for ServerCachePreference

impl Clone for UriKey

impl Clone for Value

impl Clone for PluginResponseKind

impl Clone for BindIpVersion

impl Clone for CacheAction

impl Clone for Action

impl Clone for kvarn::prelude::IpAddr

impl Clone for kvarn::prelude::SocketAddr

impl Clone for CacheControlError

impl Clone for SanitizeError

impl Clone for kvarn::prelude::utils::prelude::fmt::Alignment

impl Clone for kvarn::prelude::utils::prelude::io::ErrorKind

impl Clone for SeekFrom

impl Clone for Ipv6MulticastScope

impl Clone for Shutdown

impl Clone for AsciiChar

impl Clone for kvarn::prelude::utils::prelude::compact_str::core::cmp::Ordering

impl Clone for Infallible

impl Clone for FpCategory

impl Clone for IntErrorKind

impl Clone for SearchStep

impl Clone for kvarn::prelude::utils::prelude::compact_str::core::sync::atomic::Ordering

impl Clone for TryReserveErrorKind

impl Clone for VarError

impl Clone for BacktraceStyle

impl Clone for std::sync::mpsc::RecvTimeoutError

impl Clone for std::sync::mpsc::TryRecvError

impl Clone for _Unwind_Action

impl Clone for _Unwind_Reason_Code

impl Clone for base64::decode::DecodeError

impl Clone for DecodeSliceError

impl Clone for EncodeSliceError

impl Clone for DecodePaddingMode

impl Clone for BroCatliResult

impl Clone for BrotliEncoderMode

impl Clone for Union1

impl Clone for CodeBlockState

impl Clone for BrotliEncoderOperation

impl Clone for BrotliEncoderStreamState

impl Clone for IsFirst

impl Clone for ContextType

impl Clone for BrotliEncoderParameter

impl Clone for FlushCompress

impl Clone for FlushDecompress

impl Clone for Status

impl Clone for PollNext

impl Clone for ErrorLevel

impl Clone for kvarn_quinn::connection::SendDatagramError

impl Clone for kvarn_quinn::recv_stream::ReadError

impl Clone for ReadExactError

impl Clone for ReadToEndError

impl Clone for StoppedError

impl Clone for kvarn_quinn::send_stream::WriteError

impl Clone for log::Level

impl Clone for log::LevelFilter

impl Clone for PrefilterConfig

impl Clone for RemovalCause

impl Clone for Sign

impl Clone for Directed

impl Clone for Direction

impl Clone for Undirected

impl Clone for BernoulliError

impl Clone for WeightedError

impl Clone for IndexVec

§How can I implement `Clone`?