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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
//! `Borrow`, `AsRef`, `Deref`: my head hurts now
//!
//!   - **Date:** January 31, 2017
//!   - **Subject:** Three traits which are essential for designing good, Rustic APIs.
//!   - [**Audio**][mp3]
//!
//! [mp3]: https://www.podtrac.com/pts/redirect.mp3/cdn.newrustacean.com/file/newrustacean/e018.mp3
//!
//! <audio style="width: 100%" title="`Borrow`, `AsRef`, `Deref`: my head hurts now" controls preload=metadata><source src="https://www.podtrac.com/pts/redirect.mp3/cdn.newrustacean.com/file/newrustacean/e018.mp3"></audio>
//!
//!
//! Notes
//! -----
//!
//! `Borrow`, `AsRef`, and `Deref` are a little complicated, but they're
//! well-worth understanding. Together, they give you tools for dealing with
//! everything from `HashMap` and friends to conversions involving smart pointer
//! types to easily using `String` and `str` or `Vec` and slice together.
//!
//!
//! Links
//! -----
//!
//!   - `AsRef`, `Borrow`, and `Deref`:
//!       + [`Borrow` and `AsRef`][book-borrow-asref] in _The Rust Programming Language_
//!       + [`collections::borrow::Borrow`][borrow]
//!       + [`std::convert::AsRef`][asref]
//!       + [`std::ops::Deref`][deref]
//!   - [persistent data structures][pds]
//!   - ["Rust and Rest"] – Arnin Roacher
//!   - [sentry-cli]
//!   - Particularly relevant previous episodes:
//!       + [e008: Just like something else][e008]
//!       + [e009: Composing a Rustic tune][e009]
//!       + [e017: Point me where I need to go][e017]
//!       + [interview::2: Raph Levien][interview 2]
//!
//! [book-borrow-asref]: https://doc.rust-lang.org/stable/book/borrow-and-asref.html
//! [borrow]: https://doc.rust-lang.org/stable/collections/borrow/trait.Borrow.html
//! [asref]: https://doc.rust-lang.org/stable/std/convert/trait.AsRef.html
//! [deref]: https://doc.rust-lang.org/stable/std/ops/trait.Deref.html
//! [pds]: https://en.wikipedia.org/wiki/Persistent_data_structure
//! ["Rust and Rest"]: http://lucumr.pocoo.org/2016/7/10/rust-rest/
//! [sentry-cli]: https://github.com/getsentry/sentry-cli/
//! [e008]: https://www.newrustacean.com/show_notes/e008/
//! [e009]: https://www.newrustacean.com/show_notes/e009/
//! [e017]: https://www.newrustacean.com/show_notes/e017/
//! [interview 2]: https://www.newrustacean.com/show_notes/interview/_2/index.html
//!
//!
//! Sponsors
//! --------
//!
//!   - Aleksey Pirogov
//!   - Andreas Fischer
//!   - Andrew Thompson
//!   - Ben Whitley
//!   - Cameron Mochrie
//!   - [Chris Palmer]
//!   - [Christopher Giffard]
//!   - [Daniel Collin]
//!   - [Derek Morr]
//!   - [Jakub "Limeth" Hlusička]
//!   - Jordan Henderson
//!   - [Jupp Müller]
//!   - Keith Gray
//!   - Lachlan Collins
//!   - Luca Schmid
//!   - Matt Rudder
//!   - Matthew Piziak
//!   - Micael Bergeron
//!   - Ovidiu Curcan
//!   - [Pascal Hertleif]
//!   - Peter Tillemans
//!   - Philipp Keller
//!   - Ralph Giles ("rillian")
//!   - Raph Levien
//!   - reddraggone9
//!   - Ryan Ollos
//!   - Steven Murawski
//!   - Vesa Kaihlavirta
//!   - Vlad Bezden
//!   - [William Roe]
//!   - Zaki
//!
//! [Chris Palmer]: http://red-oxide.org/
//! [Christopher Giffard]: http://blog.cgiffard.com
//! [Daniel Collin]: https://twitter.com/daniel_collin
//! [Derek Morr]: https://twitter.com/derekmorr
//! [Jakub "Limeth" Hlusička]: https://github.com/Limeth
//! [Jupp Müller]: https://de.linkedin.com/in/juppm
//! [Pascal Hertleif]: https://pascalhertleif.de/
//! [Philipp Keller]: https://twitter.com/hansapla
//! [William Roe]: http://willroe.me
//!
//! (Thanks to the couple people donating who opted out of the reward tier, as
//! well. You know who you are!)
//!
//! ### Become a sponsor
//!
//!   - <a href="https://www.patreon.com/newrustacean" rel="payment">Patreon</a>
//!   - [Venmo](https://venmo.com/chriskrycho)
//!   - [Dwolla](https://www.dwolla.com/hub/chriskrycho)
//!   - [Cash.me](https://cash.me/$chriskrycho)
//!   - [Flattr](https://flattr.com/profile/chriskrycho)
//!   - [PayPal.me](https://paypal.me/chriskrycho)
//!
//!
//! Contact
//! -------
//!
//!   - New Rustacean:
//!     + Twitter: [@newrustacean](https://www.twitter.com/newrustacean)
//!     + Email: [hello@newrustacean.com](mailto:hello@newrustacean.com)
//!   - Chris Krycho
//!     + GitHub: [chriskrycho](https://github.com/chriskrycho)
//!     + Twitter: [@chriskrycho](https://www.twitter.com/chriskrycho)

use std::borrow::Borrow;
use std::convert::AsRef;
use std::ops::Deref;

/// A struct for showing that you cannot use `Borrow`, `AsRef`
pub struct NoImplsAtAll {
    _contents: [u8; 8],
}

impl NoImplsAtAll {
    pub fn new(contents: &[u8; 8]) -> NoImplsAtAll {
        NoImplsAtAll {
            _contents: *contents,
        }
    }
}

/// Demonstrate borrowing the internal contents of the item.
///
/// Note that, because of the specifics of what we're doing here, the
/// implementations of `Borrow`, `AsRef`, and `Deref` here are identical. This
/// will often, but not always, be the case, depending on the types and
/// conversions in question.
pub struct HasAllTheImpls {
    contents: [u8; 8],
}

impl HasAllTheImpls {
    pub fn new(contents: &[u8; 8]) -> HasAllTheImpls {
        HasAllTheImpls {
            contents: *contents,
        }
    }
}

impl Borrow<[u8]> for HasAllTheImpls {
    fn borrow(&self) -> &[u8] {
        &self.contents
    }
}

impl AsRef<[u8]> for HasAllTheImpls {
    fn as_ref(&self) -> &[u8] {
        &self.contents
    }
}

impl Deref for HasAllTheImpls {
    type Target = [u8];

    fn deref(&self) -> &[u8] {
        &self.contents
    }
}

/// Take it implementing `Borrow<[u8]>`.
#[cfg_attr(feature = "cargo-clippy", allow(clippy::result_unit_err))]
pub fn takes_a_borrowable<B: Borrow<[u8]>>(b: B) -> Result<(), ()> {
    for el in b.borrow() {
        println!("el is {}", el);
    }

    Ok(())
}

/// Take it implementing `AsRef<[u8]>`. Note similarity to `takes_a_borrowable`.
// The point is to illustrate
#[cfg_attr(feature = "cargo-clippy", allow(clippy::result_unit_err))]
pub fn takes_a_reference<A: AsRef<[u8]>>(a: A) -> Result<(), ()> {
    for el in a.as_ref() {
        println!("look ma, a reference! {}", el);
    }

    Ok(())
}

/// Take the same type by `Deref` coercion at the call site.
#[cfg_attr(feature = "cargo-clippy", allow(clippy::result_unit_err))]
pub fn coerces_via_deref(coerced: &[u8]) -> Result<(), ()> {
    for el in coerced {
        println!("we borrowed it as a straight-up reference: {}", el);
    }

    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn e018_demonstrate_borrow() {
        let to_borrow: [u8; 8] = [1, 2, 3, 4, 5, 6, 7, 8];
        assert_eq!(Ok(()), takes_a_borrowable(to_borrow));
        assert_eq!(Ok(()), takes_a_borrowable(to_borrow.to_vec()));

        let borrow_this_too: [u8; 8] = [0, 1, 2, 3, 4, 5, 6, 7];
        assert_eq!(Ok(()), takes_a_borrowable(borrow_this_too));

        let _contents_not_borrowable = NoImplsAtAll::new(&to_borrow);

        // would fail:
        // takes_a_borrowable(&_contents_not_borrowable);

        let contents_borrowable = HasAllTheImpls::new(&to_borrow);
        assert_eq!(Ok(()), takes_a_borrowable(contents_borrowable));
    }

    #[test]
    fn e018_demonstrate_as_ref() {}

    #[test]
    fn e018_demonstrate_deref() {
        let basic: [u8; 8] = [1, 2, 3, 4, 5, 6, 7, 8];
        assert_eq!(Ok(()), coerces_via_deref(&basic));

        let to_coerce = HasAllTheImpls::new(&basic);
        assert_eq!(Ok(()), coerces_via_deref(&to_coerce));
    }
}