Struct Options

pub struct Options {
    pub recursive: bool,
    pub rsync_command: Option<Vec<String>>,
    pub ssh_command: Option<Vec<String>>,
    pub list_only: bool,
    pub verbose: u32,
}

Command-line options controlling the local and remote processes.

These are held inside a Client, and are passed to the remote side when the connection is opened.

use rsyn::{Client, Options};
let mut client = Client::from_str("rsync.example.com::mod").unwrap();
client.set_options(Options {
    verbose: 2,
    recursive: true,
    .. Options::default()
});

Fields

recursive: bool

Recurse into directories.

rsync_command: Option<Vec<String>>

Command to run to start the rsync server, typically remotely.

May be multiple words, which will be passed as separate shell arguments.

If unset, just “rsync”.

ssh_command: Option<Vec<String>>

Command to open a connection to the remote server.

May be multiple words to include options, which will be passed as separate shell arguments.

If unset, just “ssh”.

list_only: bool

Only list files, don’t transfer contents.

In some cases the server will infer this.

verbose: u32

Be verbose.

(This is passed to the server to encourage it to be verbose too.)

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Options

Returns the “default value” for a type.

impl PartialEq for Options

fn eq(&self, other: &Options) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Options

impl StructuralPartialEq for Options