Enum Report

pub(crate) enum Report<'a> {
    Message(&'a OsStr),
    PathChange {
        change_kind: ChangeKind,
        path_kind: PathKind,
        path: &'a Path,
    },
    Empty,
}

Change information reported by rsync.

See the --itemize-changes section in man 1 rsync.

Variants

Message(&'a OsStr)

rsync message string.

PathChange

Changes have been made to a local path.

Fields

change_kind: ChangeKind

Kind of change that is being made.

path_kind: PathKind

Kind of path that is being changed.

path: &'a Path

Path to the item in question.

Empty

rsync did not report any changes.

Implementations

impl<'a> Report<'a>

pub(crate) fn parser(line: &'a [u8]) -> ModalResult<Self>

Parse a Self from one line of rsync --itemize-changes.

Callers should be careful to remove trailing newlines from rsync output as this function will not remove them.

For accepted inputs, see the --itemize-changes section in man 1 rsync.

Errors

Throws an error if input is of an unknown format

pub(crate) fn file_content_updated(&self) -> Result<Option<&Path>>

Check if file content was changed in such a way that it should be extracted again.

Returns Ok(Some(path)), where path points to the file if there were changes. Otherwise Ok(None).

This does not consider the following to be “relevant” changes:

• Directory creation or other “local changes” as defined by rsync.
• Sending to remote. This should not be possible when using this tool.
• Attribute changes.
• File deletion.

Errors

Returns an error if self:

• Holds a non-deletion message from rsync.
• Reports a change to a non-file object. See PathKind.

Trait Implementations

impl<'a> Clone for Report<'a>

fn clone(&self) -> Report<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Report<'a>

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

Formats the value using the given formatter.