Trait ibc_primitives::prelude::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.

Object Safety§

This trait is not object safe.

Trait ibc_primitives::prelude::Clone

Required Methods§

fn clone(&self) -> Self

Provided Methods§

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

Object Safety§

Implementors§

impl Clone for Expiry

impl Clone for TryReserveErrorKind

impl Clone for AsciiChar

impl Clone for core::cmp::Ordering

impl Clone for Infallible

impl Clone for Which

impl Clone for core::fmt::Alignment

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 core::sync::atomic::Ordering

impl Clone for VarError

impl Clone for 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 borsh::nostd_io::ErrorKind

impl Clone for Definition

impl Clone for Fields

impl Clone for ibc_proto::cosmos::base::snapshots::v1beta1::snapshot_item::Item

impl Clone for ibc_proto::cosmos::crypto::keyring::v1::record::Item

impl Clone for ibc_proto::cosmos::gov::v1beta1::ProposalStatus

impl Clone for VoteOption

impl Clone for AuthorizationType

impl Clone for BondStatus

impl Clone for Infraction

impl Clone for ibc_proto::cosmos::staking::v1beta1::InfractionType

impl Clone for Validators

impl Clone for SignMode

impl Clone for ibc_proto::cosmos::tx::signing::v1beta1::signature_descriptor::data::Sum

impl Clone for BroadcastMode

impl Clone for OrderBy

impl Clone for ibc_proto::cosmos::tx::v1beta1::mode_info::Sum

impl Clone for VerificationState

impl Clone for EnumType

impl Clone for FieldPresence

impl Clone for JsonFormat

impl Clone for MessageEncoding

impl Clone for RepeatedFieldEncoding

impl Clone for StringFieldValidation

impl Clone for Label

impl Clone for ibc_proto::google::protobuf::field_descriptor_proto::Type

impl Clone for CType

impl Clone for JsType

impl Clone for OptionRetention

impl Clone for OptionTargetType

impl Clone for OptimizeMode

impl Clone for Semantic

impl Clone for IdempotencyLevel

impl Clone for ibc_proto::ibc::applications::interchain_accounts::v1::Type

impl Clone for ibc_proto::ibc::core::channel::v1::acknowledgement::Response

impl Clone for Order

impl Clone for ResponseResultType

impl Clone for ibc_proto::ibc::core::channel::v1::State

impl Clone for ibc_proto::ibc::core::connection::v1::State

impl Clone for ibc_proto::interchain_security::ccv::provider::v1::throttled_packet_data_wrapper::Data

impl Clone for ibc_proto::interchain_security::ccv::v1::consumer_packet_data::Data

impl Clone for ibc_proto::interchain_security::ccv::v1::consumer_packet_data_v1::Data

impl Clone for ConsumerPacketDataType

impl Clone for ibc_proto::interchain_security::ccv::v1::InfractionType

impl Clone for MetaForm

impl Clone for PortableForm

impl Clone for TypeDefPrimitive

impl Clone for InstanceType

impl Clone for Schema

impl Clone for Category

impl Clone for serde_json::value::Value