rsyn 0.0.1

[pre-alpha] Wire-compatible rsync client
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Command-line options controlling the local and remote processes.

#[allow(unused_imports)]
use log::{debug, error, info, trace, warn};

/// Command-line options controlling the local and remote processes.
///
/// These are held inside a [`Client`](struct.Client.html),
/// 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()
/// });
/// ```
#[derive(Clone, Eq, PartialEq, Debug, Default)]
pub struct Options {
    /// Recurse into directories.
    pub recursive: bool,

    /// 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".
    pub rsync_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".
    pub ssh_command: Option<Vec<String>>,

    /// Only list files, don't transfer contents.
    ///
    /// In some cases the server will infer this.
    pub list_only: bool,

    /// Be verbose.
    ///
    /// (This is passed to the server to encourage it to be verbose too.)
    pub verbose: u32,
}