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
/// The `TakeRef` trait for Rust enables treating references and values interchangeably.
///
/// # Examples
///
/// `take_value` can take in both values and references.
/// If it takes in a reference, no clone is needed unless `take` is called.
/// ```
/// use take_ref::TakeRef;
///
/// fn take_value(value: impl TakeRef<i64>) {
/// assert_eq!(*value.as_ref(), 42); // `as_ref` references the value in place.
/// assert_eq!(*value.as_ref(), 42); // `as_ref` can be repeated until `take` is called.
/// assert_eq!(value.take(), 42); // `take` consumes the value.
/// }
///
/// take_value(42);
///
/// let i = 42;
/// take_value(&i);
///
/// let mut i = 42;
/// take_value(&mut i);
/// ```
///
/// ## Disallowed Operations
///
/// `ref_taken` fails to compile since it attempts to reference `value` after `take` has already consumed it.
/// ```compile_fail
/// fn ref_taken(value: impl take_ref::TakeRef<i64>) {
/// value.take(); // `take` consumes the value.
/// value.as_ref(); // This call is disallowed since the value has been consumed.
/// }
/// ```
///
/// `take_taken` fails to compile since it attempts to `take` `value` after `take` has already consumed it.
/// ```compile_fail
/// fn take_taken(value: impl take_ref::TakeRef<i64>) {
/// value.take(); // `take` consumes the value.
/// value.take(); // This call is disallowed since the value has been consumed.
/// }
/// ```