From c9cc927f27fa2fb475b772731446237345f1f270 Mon Sep 17 00:00:00 2001 From: Aidan Hobson Sayers Date: Fri, 16 Sep 2016 00:27:07 +0100 Subject: Fix libssh2_channel_wait_eof doc (see libssh2/libssh2#93) Closes #34 --- src/channel.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src') diff --git a/src/channel.rs b/src/channel.rs index d7d9b20..00f8702 100644 --- a/src/channel.rs +++ b/src/channel.rs @@ -309,7 +309,7 @@ impl<'sess> Channel<'sess> { } } - /// Wait for the remote end to acknowledge an EOF request. + /// Wait for the remote end to send EOF. pub fn wait_eof(&mut self) -> Result<(), Error> { unsafe { self.sess.rc(raw::libssh2_channel_wait_eof(self.raw)) } } -- cgit v1.2.3 From cbd99adf92917288cf9d11c50d33c029b10d6e54 Mon Sep 17 00:00:00 2001 From: Aidan Hobson Sayers Date: Fri, 16 Sep 2016 00:29:16 +0100 Subject: Hide limit_read since it's a hack (see #34) --- src/channel.rs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'src') diff --git a/src/channel.rs b/src/channel.rs index 00f8702..740ca71 100644 --- a/src/channel.rs +++ b/src/channel.rs @@ -288,7 +288,8 @@ impl<'sess> Channel<'sess> { } /// Artificially limit the number of bytes that will be read from this - /// channel. + /// channel. Hack intended for use by scp_recv only. + #[doc(hidden)] pub fn limit_read(&mut self, limit: u64) { self.read_limit = Some(limit); } -- cgit v1.2.3