loam_sdk::soroban_sdk::testutils::arbitrary::std::clone

Trait Clone

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

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

Expand description

A common trait that allows explicit creation of a duplicate value.

Calling clone always produces a new value. However, for types that are references to other data (such as smart pointers or references), the new value may still point to the same underlying data, rather than duplicating it. See Clone::clone for more details.

This distinction is especially important when using #[derive(Clone)] on structs containing smart pointers like Arc<Mutex<T>> - the cloned struct will share mutable state with the original.

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.

§`Clone` and `PartialEq`/`Eq`

Clone is intended for the duplication of objects. Consequently, when implementing both Clone and PartialEq, the following property is expected to hold:

x == x -> x.clone() == x

In other words, if an object compares equal to itself, its clone must also compare equal to the original.

For types that also implement Eq – for which x == x always holds – this implies that x.clone() == x must always be true. Standard library collections such as HashMap, HashSet, BTreeMap, BTreeSet and BinaryHeap rely on their keys respecting this property for correct behavior. Furthermore, these collections require that cloning a key preserves the outcome of the Hash and Ord methods. Thankfully, this follows automatically from x.clone() == x if Hash and Ord are correctly implemented according to their own requirements.

When deriving both Clone and PartialEq using #[derive(Clone, PartialEq)] or when additionally deriving Eq using #[derive(Clone, PartialEq, Eq)], then this property is automatically upheld – provided that it is satisfied by the underlying types.

Violating this property is a logic error. The behavior resulting from a logic error is not specified, but users of the trait must ensure that such logic errors do not result in undefined behavior. This means that unsafe code must not rely on this property being satisfied.

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

1.0.0 · Source

fn clone(&self) -> Self

Returns a duplicate of the value.

Note that what “duplicate” means varies by type:

For most types, this creates a deep, independent copy
For reference types like &T, this creates another reference to the same value
For smart pointers like Arc or Rc, this increments the reference count but still points to the same underlying data

§Examples

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

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

Example with a reference-counted type:

use std::sync::{Arc, Mutex};

let data = Arc::new(Mutex::new(vec![1, 2, 3]));
let data_clone = data.clone(); // Creates another Arc pointing to the same Mutex

{
    let mut lock = data.lock().unwrap();
    lock.push(4);
}

// Changes are visible through the clone because they share the same underlying data
assert_eq!(*data_clone.lock().unwrap(), vec![1, 2, 3, 4]);

Provided Methods§

1.0.0 · 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.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Trait Clone Copy item path

§Derivable

§How can I implement Clone?

§Clone and PartialEq/Eq

§Additional implementors

Required Methods§

fn clone(&self) -> Self

§Examples

Provided Methods§

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

Dyn Compatibility§

Implementors§

impl Clone for Context

impl Clone for loam_sdk::soroban_sdk::auth::ContractExecutable

impl Clone for InvokerContractAuthEntry

impl Clone for InvokeError

impl Clone for AccountEntryExt

impl Clone for AccountEntryExtensionV1Ext

impl Clone for AccountEntryExtensionV2Ext

impl Clone for AccountFlags

impl Clone for AccountMergeResult

impl Clone for AccountMergeResultCode

impl Clone for AllowTrustResult

impl Clone for AllowTrustResultCode

impl Clone for ArchivalProofBody

impl Clone for ArchivalProofType

impl Clone for Asset

impl Clone for AssetCode

impl Clone for AssetType

impl Clone for AuthenticatedMessage

impl Clone for BeginSponsoringFutureReservesResult

impl Clone for BeginSponsoringFutureReservesResultCode

impl Clone for BinaryFuseFilterType

impl Clone for BucketEntry

impl Clone for BucketEntryType

impl Clone for BucketListType

impl Clone for BucketMetadataExt

impl Clone for BumpSequenceResult

impl Clone for BumpSequenceResultCode

impl Clone for ChangeTrustAsset

impl Clone for ChangeTrustResult

impl Clone for ChangeTrustResultCode

impl Clone for ClaimAtom

impl Clone for ClaimAtomType

impl Clone for ClaimClaimableBalanceResult

impl Clone for ClaimClaimableBalanceResultCode

impl Clone for ClaimPredicate

impl Clone for ClaimPredicateType

impl Clone for ClaimableBalanceEntryExt

impl Clone for ClaimableBalanceEntryExtensionV1Ext

impl Clone for ClaimableBalanceFlags

impl Clone for ClaimableBalanceId

impl Clone for ClaimableBalanceIdType

impl Clone for Claimant

impl Clone for ClaimantType

impl Clone for ClawbackClaimableBalanceResult

impl Clone for ClawbackClaimableBalanceResultCode

impl Clone for ClawbackResult

impl Clone for ClawbackResultCode

impl Clone for ColdArchiveBucketEntry

impl Clone for ColdArchiveBucketEntryType

impl Clone for ConfigSettingEntry

impl Clone for ConfigSettingId

impl Clone for ContractCodeEntryExt

impl Clone for ContractCostType

impl Clone for ContractDataDurability

impl Clone for ContractEventBody

impl Clone for ContractEventType

impl Clone for loam_sdk::soroban_sdk::xdr::ContractExecutable

impl Clone for ContractExecutableType

impl Clone for ContractIdPreimage

impl Clone for ContractIdPreimageType

impl Clone for CreateAccountResult

impl Clone for CreateAccountResultCode

impl Clone for CreateClaimableBalanceResult

impl Clone for CreateClaimableBalanceResultCode

impl Clone for CryptoKeyType

impl Clone for DataEntryExt

impl Clone for EndSponsoringFutureReservesResult

impl Clone for EndSponsoringFutureReservesResultCode

Trait Clone

§How can I implement `Clone`?

§`Clone` and `PartialEq`/`Eq`