Merge pull request #37 from NobodyXu/feature/AddNewOptionToSessionBuilder

feature: Add new func SessionBuilder::compression to control compression

Author: jonhoo

src/builder.rs

@@ -49,6 +49,7 @@ pub struct SessionBuilder {
     known_hosts_check: KnownHosts,
     control_dir: Option<PathBuf>,
     config_file: Option<PathBuf>,
+    compression: Option<bool>,
 }
 
 impl Default for SessionBuilder {
@@ -62,6 +63,7 @@ impl Default for SessionBuilder {
             known_hosts_check: KnownHosts::Add,
             control_dir: None,
             config_file: None,
+            compression: None,
         }
     }
 }
@@ -137,6 +139,21 @@ impl SessionBuilder {
         self
     }
 
+    /// Enable or disable compression (including stdin, stdout, stderr, data
+    /// for forwarded TCP and unix-domain connections, sftp and scp
+    /// connections).
+    ///
+    /// Note that the ssh server can forcibly disable the compression.
+    ///
+    /// By default, ssh uses configure value set in `~/.ssh/config`.
+    ///
+    /// If `~/.ssh/config` does not enable compression, then it is disabled
+    /// by default.
+    pub fn compression(&mut self, compression: bool) -> &mut Self {
+        self.compression = Some(compression);
+        self
+    }
+
     /// Connect to the host at the given `host` over SSH using process impl, which will
     /// spawn a new ssh process for each `Child` created.
     ///
@@ -277,6 +294,12 @@ impl SessionBuilder {
             init.arg("-F").arg(config_file);
         }
 
+        if let Some(compression) = self.compression {
+            let arg = if compression { "yes" } else { "no" };
+
+            init.arg("-o").arg(format!("Compression={}", arg));
+        }
+
         init.arg(destination);
 
         // we spawn and immediately wait, because the process is supposed to fork.

src/changelog.rs

@@ -8,6 +8,7 @@ use crate::*;
 ///
 /// ## Added
 ///  - Added changelog
+///  - Added [`SessionBuilder::compression`]
 #[doc(hidden)]
 pub mod unreleased {}