objekt 0.1.2

Clone trait that is object-safe
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

Clone trait that is object-safe
===============================

[![Build Status](https://api.travis-ci.org/dtolnay/objekt.svg?branch=master)](https://travis-ci.org/dtolnay/objekt)
[![Latest Version](https://img.shields.io/crates/v/objekt.svg)](https://crates.io/crates/objekt)
[![Rust Documentation](https://img.shields.io/badge/api-rustdoc-blue.svg)](https://docs.rs/objekt/0.1/objekt/)

This crate provides a `Clone` trait that can be used in trait objects, and a
`clone_box` function that can clone any sized or dynamically sized
implementation of `Clone`. Types that implement the standard library's
[`std::clone::Clone`] trait are automatically usable this way.

[`std::clone::Clone`]: https://doc.rust-lang.org/std/clone/trait.Clone.html

The signature of `clone_box` is:

```rust
fn clone_box<T>(t: &T) -> Box<T>
where
    T: ?Sized + objekt::Clone
```

## Example

```rust
trait MyTrait: objekt::Clone {
    fn recite(&self);
}

impl MyTrait for String {
    fn recite(&self) {
        println!("{} ♫", self);
    }
}

fn main() {
    let line = "The slithy structs did gyre and gimble the namespace";

    // Build a trait object holding a String.
    // This requires String to implement MyTrait and std::clone::Clone.
    let x: Box<MyTrait> = Box::new(String::from(line));

    x.recite();

    // The type of x2 is a Box<MyTrait> cloned from x.
    let x2 = objekt::clone_box(&*x);

    x2.recite();
}
```

This crate includes a macro for concisely implementing `impl std::clone::Clone
for Box<MyTrait>` in terms of `objekt::clone_box`.

```rust
// As before.
trait MyTrait: objekt::Clone {
    /* ... */
}

objekt::clone_trait_object!(MyTrait);

// Now data structures containing Box<MyTrait> can derive Clone:
#[derive(Clone)]
struct Container {
    trait_object: Box<MyTrait>,
}
```

<br>

#### License

<sup>
Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
</sup>

<br>

<sub>
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in this crate by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.
</sub>