Skip to content

Commit

Permalink
Add ToOwned::clone_into (unstable as toowned_clone_into)
Browse files Browse the repository at this point in the history
to_owned generalizes clone; this generalizes clone_from.  Use to_owned to
give it a default impl.  Customize the impl for [T], str, and T:Clone.

Use it in Cow::clone_from to reuse resources when cloning Owned into Owned.
  • Loading branch information
scottmcm committed Apr 13, 2017
1 parent 44855a4 commit 7ec27ae
Show file tree
Hide file tree
Showing 7 changed files with 76 additions and 10 deletions.
1 change: 1 addition & 0 deletions src/doc/unstable-book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,7 @@
- [thread_local](thread-local.md)
- [thread_local_internals](thread-local-internals.md)
- [thread_local_state](thread-local-state.md)
- [toowned_clone_into](toowned-clone-into.md)
- [trace_macros](trace-macros.md)
- [trusted_len](trusted-len.md)
- [try_from](try-from.md)
Expand Down
7 changes: 7 additions & 0 deletions src/doc/unstable-book/src/toowned-clone-into.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# `toowned_clone_into`

The tracking issue for this feature is: [#41263]

[#41263]: https://github.com/rust-lang/rust/issues/41263

------------------------
38 changes: 38 additions & 0 deletions src/libcollections/borrow.rs
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,29 @@ pub trait ToOwned {
/// ```
#[stable(feature = "rust1", since = "1.0.0")]
fn to_owned(&self) -> Self::Owned;

/// Uses borrowed data to replace owned data, usually by cloning.
///
/// This is borrow-generalized version of `Clone::clone_from`.
///
/// # Examples
///
/// Basic usage:
///
/// ```
/// # #![feature(toowned_clone_into)]
/// let mut s: String = String::new();
/// "hello".clone_into(&mut s);
///
/// let mut v: Vec<i32> = Vec::new();
/// [1, 2][..].clone_into(&mut v);
/// ```
#[unstable(feature = "toowned_clone_into",
reason = "recently added",
issue = "41263")]
fn clone_into(&self, target: &mut Self::Owned) {
*target = self.to_owned();
}
}

#[stable(feature = "rust1", since = "1.0.0")]
Expand All @@ -70,6 +93,10 @@ impl<T> ToOwned for T
fn to_owned(&self) -> T {
self.clone()
}

fn clone_into(&self, target: &mut T) {
target.clone_from(self);
}
}

/// A clone-on-write smart pointer.
Expand Down Expand Up @@ -141,6 +168,17 @@ impl<'a, B: ?Sized> Clone for Cow<'a, B>
}
}
}

fn clone_from(&mut self, source: &Cow<'a, B>) {
if let Owned(ref mut dest) = *self {
if let Owned(ref o) = *source {
o.borrow().clone_into(dest);
return;
}
}

*self = source.clone();
}
}

impl<'a, B: ?Sized> Cow<'a, B>
Expand Down
13 changes: 13 additions & 0 deletions src/libcollections/slice.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1527,6 +1527,19 @@ impl<T: Clone> ToOwned for [T] {
fn to_owned(&self) -> Vec<T> {
panic!("not available with cfg(test)")
}

fn clone_into(&self, target: &mut Vec<T>) {
// drop anything in target that will not be overwritten
target.truncate(self.len());
let len = target.len();

// reuse the contained values' allocations/resources.
target.clone_from_slice(&self[..len]);

// target.len <= self.len due to the truncate above, so the
// slice here is always in-bounds.
target.extend_from_slice(&self[len..]);
}
}

////////////////////////////////////////////////////////////////////////////////
Expand Down
6 changes: 6 additions & 0 deletions src/libcollections/str.rs
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,12 @@ impl ToOwned for str {
fn to_owned(&self) -> String {
unsafe { String::from_utf8_unchecked(self.as_bytes().to_owned()) }
}

fn clone_into(&self, target: &mut String) {
let mut b = mem::replace(target, String::new()).into_bytes();
self.as_bytes().clone_into(&mut b);
*target = unsafe { String::from_utf8_unchecked(b) }
}
}

/// Methods for string slices.
Expand Down
10 changes: 10 additions & 0 deletions src/libcollections/tests/cow_str.rs
Original file line number Diff line number Diff line change
Expand Up @@ -139,3 +139,13 @@ fn check_cow_add_assign_str() {
assert_eq!("Hi, World!", owned);
assert_eq!("Hello, World!", borrowed);
}

#[test]
fn check_cow_clone_from() {
let mut c1: Cow<str> = Cow::Owned(String::with_capacity(25));
let s: String = "hi".to_string();
assert!(s.capacity() < 25);
let c2: Cow<str> = Cow::Owned(s);
c1.clone_from(&c2);
assert!(c1.into_owned().capacity() >= 25);
}
11 changes: 1 addition & 10 deletions src/libcollections/vec.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1396,16 +1396,7 @@ impl<T: Clone> Clone for Vec<T> {
}

fn clone_from(&mut self, other: &Vec<T>) {
// drop anything in self that will not be overwritten
self.truncate(other.len());
let len = self.len();

// reuse the contained values' allocations/resources.
self.clone_from_slice(&other[..len]);

// self.len <= other.len due to the truncate above, so the
// slice here is always in-bounds.
self.extend_from_slice(&other[len..]);
other.as_slice().clone_into(self);
}
}

Expand Down

0 comments on commit 7ec27ae

Please sign in to comment.