src/libcollections/borrow.rs

   1 // Copyright 2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! A module for working with borrowed data.
  12
  13 #![stable(feature = "rust1", since = "1.0.0")]
  14
  15 use core::clone::Clone;
  16 use core::cmp::{Eq, Ord, Ordering, PartialEq, PartialOrd};
  17 use core::convert::AsRef;
  18 use core::hash::{Hash, Hasher};
  19 use core::marker::Sized;
  20 use core::ops::Deref;
  21 use core::option::Option;
  22
  23 use fmt;
  24
  25 use self::Cow::*;
  26
  27 #[stable(feature = "rust1", since = "1.0.0")]
  28 pub use core::borrow::{Borrow, BorrowMut};
  29
  30 #[stable(feature = "rust1", since = "1.0.0")]
  31 impl<'a, B: ?Sized> Borrow<B> for Cow<'a, B>
  32     where B: ToOwned,
  33           <B as ToOwned>::Owned: 'a
  34 {
  35     fn borrow(&self) -> &B {
  36         &**self
  37     }
  38 }
  39
  40 /// A generalization of `Clone` to borrowed data.
  41 ///
  42 /// Some types make it possible to go from borrowed to owned, usually by
  43 /// implementing the `Clone` trait. But `Clone` works only for going from `&T`
  44 /// to `T`. The `ToOwned` trait generalizes `Clone` to construct owned data
  45 /// from any borrow of a given type.
  46 #[stable(feature = "rust1", since = "1.0.0")]
  47 pub trait ToOwned {
  48     #[stable(feature = "rust1", since = "1.0.0")]
  49     type Owned: Borrow<Self>;
  50
  51     /// Creates owned data from borrowed data, usually by cloning.
  52     #[stable(feature = "rust1", since = "1.0.0")]
  53     fn to_owned(&self) -> Self::Owned;
  54 }
  55
  56 #[stable(feature = "rust1", since = "1.0.0")]
  57 impl<T> ToOwned for T where T: Clone {
  58     type Owned = T;
  59     fn to_owned(&self) -> T {
  60         self.clone()
  61     }
  62 }
  63
  64 /// A clone-on-write smart pointer.
  65 ///
  66 /// The type `Cow` is a smart pointer providing clone-on-write functionality: it
  67 /// can enclose and provide immutable access to borrowed data, and clone the
  68 /// data lazily when mutation or ownership is required. The type is designed to
  69 /// work with general borrowed data via the `Borrow` trait.
  70 ///
  71 /// `Cow` implements `Deref`, which means that you can call
  72 /// non-mutating methods directly on the data it encloses. If mutation
  73 /// is desired, `to_mut` will obtain a mutable reference to an owned
  74 /// value, cloning if necessary.
  75 ///
  76 /// # Examples
  77 ///
  78 /// ```
  79 /// use std::borrow::Cow;
  80 ///
  81 /// # #[allow(dead_code)]
  82 /// fn abs_all(input: &mut Cow<[i32]>) {
  83 ///     for i in 0..input.len() {
  84 ///         let v = input[i];
  85 ///         if v < 0 {
  86 ///             // clones into a vector the first time (if not already owned)
  87 ///             input.to_mut()[i] = -v;
  88 ///         }
  89 ///     }
  90 /// }
  91 /// ```
  92 #[stable(feature = "rust1", since = "1.0.0")]
  93 pub enum Cow<'a, B: ?Sized + 'a>
  94     where B: ToOwned
  95 {
  96     /// Borrowed data.
  97     #[stable(feature = "rust1", since = "1.0.0")]
  98     Borrowed(#[stable(feature = "rust1", since = "1.0.0")] &'a B),
  99
 100     /// Owned data.
 101     #[stable(feature = "rust1", since = "1.0.0")]
 102     Owned(
 103         #[stable(feature = "rust1", since = "1.0.0")] <B as ToOwned>::Owned
 104     ),
 105 }
 106
 107 #[stable(feature = "rust1", since = "1.0.0")]
 108 impl<'a, B: ?Sized> Clone for Cow<'a, B> where B: ToOwned {
 109     fn clone(&self) -> Cow<'a, B> {
 110         match *self {
 111             Borrowed(b) => Borrowed(b),
 112             Owned(ref o) => {
 113                 let b: &B = o.borrow();
 114                 Owned(b.to_owned())
 115             }
 116         }
 117     }
 118 }
 119
 120 impl<'a, B: ?Sized> Cow<'a, B> where B: ToOwned {
 121     /// Acquires a mutable reference to the owned form of the data.
 122     ///
 123     /// Clones the data if it is not already owned.
 124     ///
 125     /// # Examples
 126     ///
 127     /// ```
 128     /// use std::borrow::Cow;
 129     ///
 130     /// let mut cow: Cow<[_]> = Cow::Owned(vec![1, 2, 3]);
 131     ///
 132     /// let hello = cow.to_mut();
 133     ///
 134     /// assert_eq!(hello, &[1, 2, 3]);
 135     /// ```
 136     #[stable(feature = "rust1", since = "1.0.0")]
 137     pub fn to_mut(&mut self) -> &mut <B as ToOwned>::Owned {
 138         match *self {
 139             Borrowed(borrowed) => {
 140                 *self = Owned(borrowed.to_owned());
 141                 self.to_mut()
 142             }
 143             Owned(ref mut owned) => owned,
 144         }
 145     }
 146
 147     /// Extracts the owned data.
 148     ///
 149     /// Clones the data if it is not already owned.
 150     ///
 151     /// # Examples
 152     ///
 153     /// ```
 154     /// use std::borrow::Cow;
 155     ///
 156     /// let cow: Cow<[_]> = Cow::Owned(vec![1, 2, 3]);
 157     ///
 158     /// let hello = cow.into_owned();
 159     ///
 160     /// assert_eq!(vec![1, 2, 3], hello);
 161     /// ```
 162     #[stable(feature = "rust1", since = "1.0.0")]
 163     pub fn into_owned(self) -> <B as ToOwned>::Owned {
 164         match self {
 165             Borrowed(borrowed) => borrowed.to_owned(),
 166             Owned(owned) => owned,
 167         }
 168     }
 169 }
 170
 171 #[stable(feature = "rust1", since = "1.0.0")]
 172 impl<'a, B: ?Sized> Deref for Cow<'a, B> where B: ToOwned {
 173     type Target = B;
 174
 175     fn deref(&self) -> &B {
 176         match *self {
 177             Borrowed(borrowed) => borrowed,
 178             Owned(ref owned) => owned.borrow(),
 179         }
 180     }
 181 }
 182
 183 #[stable(feature = "rust1", since = "1.0.0")]
 184 impl<'a, B: ?Sized> Eq for Cow<'a, B> where B: Eq + ToOwned {}
 185
 186 #[stable(feature = "rust1", since = "1.0.0")]
 187 impl<'a, B: ?Sized> Ord for Cow<'a, B> where B: Ord + ToOwned {
 188     #[inline]
 189     fn cmp(&self, other: &Cow<'a, B>) -> Ordering {
 190         Ord::cmp(&**self, &**other)
 191     }
 192 }
 193
 194 #[stable(feature = "rust1", since = "1.0.0")]
 195 impl<'a, 'b, B: ?Sized, C: ?Sized> PartialEq<Cow<'b, C>> for Cow<'a, B>
 196     where B: PartialEq<C> + ToOwned,
 197           C: ToOwned
 198 {
 199     #[inline]
 200     fn eq(&self, other: &Cow<'b, C>) -> bool {
 201         PartialEq::eq(&**self, &**other)
 202     }
 203 }
 204
 205 #[stable(feature = "rust1", since = "1.0.0")]
 206 impl<'a, B: ?Sized> PartialOrd for Cow<'a, B> where B: PartialOrd + ToOwned {
 207     #[inline]
 208     fn partial_cmp(&self, other: &Cow<'a, B>) -> Option<Ordering> {
 209         PartialOrd::partial_cmp(&**self, &**other)
 210     }
 211 }
 212
 213 #[stable(feature = "rust1", since = "1.0.0")]
 214 impl<'a, B: ?Sized> fmt::Debug for Cow<'a, B>
 215     where B: fmt::Debug + ToOwned,
 216           <B as ToOwned>::Owned: fmt::Debug
 217 {
 218     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 219         match *self {
 220             Borrowed(ref b) => fmt::Debug::fmt(b, f),
 221             Owned(ref o) => fmt::Debug::fmt(o, f),
 222         }
 223     }
 224 }
 225
 226 #[stable(feature = "rust1", since = "1.0.0")]
 227 impl<'a, B: ?Sized> fmt::Display for Cow<'a, B>
 228     where B: fmt::Display + ToOwned,
 229           <B as ToOwned>::Owned: fmt::Display
 230 {
 231     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 232         match *self {
 233             Borrowed(ref b) => fmt::Display::fmt(b, f),
 234             Owned(ref o) => fmt::Display::fmt(o, f),
 235         }
 236     }
 237 }
 238
 239 #[stable(feature = "rust1", since = "1.0.0")]
 240 impl<'a, B: ?Sized> Hash for Cow<'a, B> where B: Hash + ToOwned {
 241     #[inline]
 242     fn hash<H: Hasher>(&self, state: &mut H) {
 243         Hash::hash(&**self, state)
 244     }
 245 }
 246
 247 #[stable(feature = "rust1", since = "1.0.0")]
 248 #[allow(deprecated)]
 249 impl<'a, T: ?Sized + ToOwned> AsRef<T> for Cow<'a, T> {
 250     fn as_ref(&self) -> &T {
 251         self
 252     }
 253 }