Struct rsync_list::Config

#[non_exhaustive]
pub struct Config<'a> {
    pub source: &'a OsStr,
    pub exclude: &'a [&'a OsStr],
    pub include: &'a [&'a OsStr],
    pub executable: &'a OsStr,
    pub links: bool,
    pub recursive: bool,
}

Configuration for a list.

Many options refernce the rsync command line options and syntax. See https://download.samba.org/pub/rsync/rsync.html for the reference documentation on those options.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

source: &'a OsStr

The source to list.

Example: rsync://example.com/path Example: me@example.com:/path

These are the same syntax as the rsync command line.

exclude: &'a [&'a OsStr]

Patterns to exclude from the listing.

Example: www/*.gz

This corresponds to rsync’s –exclude flag.

include: &'a [&'a OsStr]

Patterns not to exclude..

Example: www/*.tar.gz

This corresponds to rsync’s –include flag.

executable: &'a OsStr

The rsync executable to use.

This will be looked for in $PATH if it does not contain any directory separators.

Default: rsync

links: bool

If links should be reported. If false links will be reported as the file that they point to.

Note: The last modified time will always be that of the link, not that of the target.

Default: true

recursive: bool

Recursively list the source.

Default: true

Implementations

impl<'a> Config<'a>

pub fn new(source: &'a impl AsRef<OsStr> + ?Sized) -> Self

pub fn list(&self) -> impl Stream<Item = Result<Entry, Error>>

Trait Implementations

impl<'a> Debug for Config<'a>

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

Formats the value using the given formatter.