Struct SendSshArgs

pub struct SendSshArgs {

    pub sources: Vec<String>,
    pub destination: String,
    pub tcp_port: Option<u16>,
    pub mdns_resolve_timeout_ms: u64,
    pub ssh_timeout_ms: u64,
    pub ip_version: IpVersion,
    pub ssh_port: u16,
    pub compression: Option<Compression>,
    pub ssh_private_key_path: Option<PathBuf>,
    pub ssh_key_dir: Option<PathBuf>,
    pub start_port: u16,
    pub end_port: u16,
    pub mmap: bool,
}

Fields

sources: Vec<String>

Source files or directories

destination: String

Destination file or directory

tcp_port: Option<u16>

Port that will be used to do the transfer via TCP. Prefer leaving this value empty. If no port is specified, the remote will attempt to find a free port. Don’t use this unless you have very specific needs.

mdns_resolve_timeout_ms: u64

Maximum time (ms) to attempt to resolve IP of mDNS hostname

ssh_timeout_ms: u64

Maximum time (ms) to attempt to establish an SSH connection

ip_version: IpVersion

Preferred IP version (attempts to fall back to another variant if the preferred version is not found)

ssh_port: u16

Port for SSH

compression: Option<Compression>

Compression format

ssh_private_key_path: Option<PathBuf>

Path to the SSH private key to use for authorization (default: looks for a key in ~/.ssh)

ssh_key_dir: Option<PathBuf>

Provide a path to a directory containing SSH key(s) to use for auth. Default: $HOME/.ssh on Unix and $APP_DATA/.ssh on windows

start_port: u16

Start of the port range to look for free ports for TCP transfer. IANA recommends: 49152-65535 for dynamic use.

end_port: u16

end of the port range to look for free ports for TCP transfer

mmap: bool

Use memory mapping mode

Implementations

impl SendSshArgs

pub fn is_sending(&self) -> bool

Returns whether the configuration is to send data to a remote

Trait Implementations

impl Args for SendSshArgs

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Debug for SendSshArgs

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for SendSshArgs

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.