From f1f6c1286f24f6f762a9b195ac678b55d20c9a9b Mon Sep 17 00:00:00 2001 From: Alex Crichton Date: Thu, 20 Nov 2014 09:23:43 -0800 Subject: Rename unwrap functions to into_inner This change applies the conventions to unwrap listed in [RFC 430][rfc] to rename non-failing `unwrap` methods to `into_inner`. This is a breaking change, but all `unwrap` methods are retained as `#[deprecated]` for the near future. To update code rename `unwrap` method calls to `into_inner`. [rfc]: https://github.com/rust-lang/rfcs/pull/430 [breaking-change] Closes #13159 cc #19091 --- src/libstd/io/buffered.rs | 26 +++++++++++++++++++++----- src/libstd/io/mem.rs | 14 +++++++++++--- src/libstd/io/tempfile.rs | 6 +++++- src/libstd/io/util.rs | 12 ++++++++++-- 4 files changed, 47 insertions(+), 11 deletions(-) (limited to 'src/libstd/io') diff --git a/src/libstd/io/buffered.rs b/src/libstd/io/buffered.rs index 25e85f33aa5..148323762c8 100644 --- a/src/libstd/io/buffered.rs +++ b/src/libstd/io/buffered.rs @@ -83,7 +83,11 @@ impl BufferedReader { /// Unwraps this `BufferedReader`, returning the underlying reader. /// /// Note that any leftover data in the internal buffer is lost. - pub fn unwrap(self) -> R { self.inner } + pub fn into_inner(self) -> R { self.inner } + + /// Deprecated, use into_inner() instead + #[deprecated = "renamed to into_inner()"] + pub fn unwrap(self) -> R { self.into_inner() } } impl Buffer for BufferedReader { @@ -180,11 +184,15 @@ impl BufferedWriter { /// Unwraps this `BufferedWriter`, returning the underlying writer. /// /// The buffer is flushed before returning the writer. - pub fn unwrap(mut self) -> W { + pub fn into_inner(mut self) -> W { // FIXME(#12628): is panicking the right thing to do if flushing panicks? self.flush_buf().unwrap(); self.inner.take().unwrap() } + + /// Deprecated, use into_inner() instead + #[deprecated = "renamed to into_inner()"] + pub fn unwrap(self) -> W { self.into_inner() } } impl Writer for BufferedWriter { @@ -244,7 +252,11 @@ impl LineBufferedWriter { /// Unwraps this `LineBufferedWriter`, returning the underlying writer. /// /// The internal buffer is flushed before returning the writer. - pub fn unwrap(self) -> W { self.inner.unwrap() } + pub fn into_inner(self) -> W { self.inner.into_inner() } + + /// Deprecated, use into_inner() instead + #[deprecated = "renamed to into_inner()"] + pub fn unwrap(self) -> W { self.into_inner() } } impl Writer for LineBufferedWriter { @@ -341,10 +353,14 @@ impl BufferedStream { /// /// The internal buffer is flushed before returning the stream. Any leftover /// data in the read buffer is lost. - pub fn unwrap(self) -> S { + pub fn into_inner(self) -> S { let InternalBufferedWriter(w) = self.inner.inner; - w.unwrap() + w.into_inner() } + + /// Deprecated, use into_inner() instead + #[deprecated = "renamed to into_inner()"] + pub fn unwrap(self) -> S { self.into_inner() } } impl Buffer for BufferedStream { diff --git a/src/libstd/io/mem.rs b/src/libstd/io/mem.rs index 21de6c2013d..f27951f263d 100644 --- a/src/libstd/io/mem.rs +++ b/src/libstd/io/mem.rs @@ -62,7 +62,7 @@ impl Writer for Vec { /// let mut w = MemWriter::new(); /// w.write(&[0, 1, 2]); /// -/// assert_eq!(w.unwrap(), vec!(0, 1, 2)); +/// assert_eq!(w.into_inner(), vec!(0, 1, 2)); /// ``` #[deprecated = "use the Vec Writer implementation directly"] #[deriving(Clone)] @@ -95,7 +95,11 @@ impl MemWriter { /// Unwraps this `MemWriter`, returning the underlying buffer #[inline] - pub fn unwrap(self) -> Vec { self.buf } + pub fn into_inner(self) -> Vec { self.buf } + + /// Deprecated, use into_inner() instead + #[deprecated = "renamed to into_inner()"] + pub fn unwrap(self) -> Vec { self.into_inner() } } impl Writer for MemWriter { @@ -150,7 +154,11 @@ impl MemReader { /// Unwraps this `MemReader`, returning the underlying buffer #[inline] - pub fn unwrap(self) -> Vec { self.buf } + pub fn into_inner(self) -> Vec { self.buf } + + /// Deprecated, use into_inner() instead + #[deprecated = "renamed to into_inner()"] + pub fn unwrap(self) -> Vec { self.into_inner() } } impl Reader for MemReader { diff --git a/src/libstd/io/tempfile.rs b/src/libstd/io/tempfile.rs index a232231733d..4788ba79b7f 100644 --- a/src/libstd/io/tempfile.rs +++ b/src/libstd/io/tempfile.rs @@ -73,11 +73,15 @@ impl TempDir { /// Unwrap the wrapped `std::path::Path` from the `TempDir` wrapper. /// This discards the wrapper so that the automatic deletion of the /// temporary directory is prevented. - pub fn unwrap(self) -> Path { + pub fn into_inner(self) -> Path { let mut tmpdir = self; tmpdir.path.take().unwrap() } + /// Deprecated, use into_inner() instead + #[deprecated = "renamed to into_inner()"] + pub fn unwrap(self) -> Path { self.into_inner() } + /// Access the wrapped `std::path::Path` to the temporary directory. pub fn path<'a>(&'a self) -> &'a Path { self.path.as_ref().unwrap() diff --git a/src/libstd/io/util.rs b/src/libstd/io/util.rs index 4d491beb87b..8e0cd660816 100644 --- a/src/libstd/io/util.rs +++ b/src/libstd/io/util.rs @@ -28,7 +28,11 @@ impl LimitReader { } /// Consumes the `LimitReader`, returning the underlying `Reader`. - pub fn unwrap(self) -> R { self.inner } + pub fn into_inner(self) -> R { self.inner } + + /// Deprecated, use into_inner() instead + #[deprecated = "renamed to into_inner"] + pub fn unwrap(self) -> R { self.into_inner() } /// Returns the number of bytes that can be read before the `LimitReader` /// will return EOF. @@ -207,10 +211,14 @@ impl TeeReader { /// Consumes the `TeeReader`, returning the underlying `Reader` and /// `Writer`. - pub fn unwrap(self) -> (R, W) { + pub fn into_inner(self) -> (R, W) { let TeeReader { reader, writer } = self; (reader, writer) } + + /// Deprecated, use into_inner() instead + #[deprecated = "renamed to into_inner"] + pub fn unwrap(self) -> (R, W) { self.into_inner() } } impl Reader for TeeReader { -- cgit 1.4.1-3-g733a5