Trait frame_support::dispatch::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
    }
}

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 frame_support::dispatch::Clone

Required Methods§

fn clone(&self) -> Self

Provided Methods§

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

Implementors§

impl Clone for Never

impl Clone for Void

impl Clone for StorageEntryModifierIR

impl Clone for StorageHasherIR

impl Clone for frame_support::pallet_prelude::DispatchError

impl Clone for InvalidTransaction

impl Clone for TransactionSource

impl Clone for TransactionValidityError

impl Clone for UnknownTransaction

impl Clone for ChildInfo

impl Clone for ChildType

impl Clone for StateVersion

impl Clone for ProcessMessageError

impl Clone for LookupError

impl Clone for BalanceStatus

impl Clone for DepositConsequence

impl Clone for ExistenceRequirement

impl Clone for Fortitude

impl Clone for Precision

impl Clone for Preservation

impl Clone for Provenance

impl Clone for Restriction

impl Clone for PaymentStatus

impl Clone for DispatchClass

impl Clone for Pays

impl Clone for frame_support::dispatch::fmt::Alignment

impl Clone for TryReserveErrorKind

impl Clone for core::cmp::Ordering

impl Clone for Infallible

impl Clone for Which

impl Clone for IpAddr

impl Clone for Ipv6MulticastScope

impl Clone for core::net::socket_addr::SocketAddr

impl Clone for FpCategory

impl Clone for IntErrorKind

impl Clone for SearchStep

impl Clone for core::sync::atomic::Ordering

impl Clone for VarError

impl Clone for std::io::SeekFrom

impl Clone for std::io::error::ErrorKind

impl Clone for Shutdown

impl Clone for BacktraceStyle

impl Clone for RecvTimeoutError

impl Clone for TryRecvError

impl Clone for _Unwind_Action

impl Clone for _Unwind_Reason_Code

impl Clone for PrintFmt

impl Clone for SecondsFormat

impl Clone for Fixed

impl Clone for Numeric

impl Clone for Pad

impl Clone for ParseErrorKind

impl Clone for Month

impl Clone for RoundingError

impl Clone for Weekday

impl Clone for StorageEntryModifier

impl Clone for StorageHasher

impl Clone for hex::error::FromHexError

impl Clone for log::Level

impl Clone for log::LevelFilter

impl Clone for Sign

impl Clone for num_format::error_kind::ErrorKind

impl Clone for Grouping

impl Clone for Locale

impl Clone for MetaForm

impl Clone for PortableForm

impl Clone for TypeDefPrimitive

impl Clone for Category

impl Clone for serde_json::value::Value

impl Clone for ArithmeticError

impl Clone for Rounding

impl Clone for SignedRounding

impl Clone for DeriveError

impl Clone for DeriveJunction