Struct GetReport 

pub struct GetReport {
    pub outcome: GetOutcome,
    pub dry_run: bool,
    pub on_conflict: OnConflict,
    pub source: SettingSource,
    pub counts: GetCounts,
    pub bytes: ByteTotals,
    pub problem: Option<Error>,
    pub files: Vec<GetRow>,
}

The whole result of a get: operation information plus one row per file.

Fields

outcome: GetOutcome

dry_run: bool

on_conflict: OnConflict

source: SettingSource

counts: GetCounts

bytes: ByteTotals

problem: Option<Error>

An operation-level problem, such as nothing matching the request

files: Vec<GetRow>

Implementations

impl GetReport

pub fn problem( code: ErrorCode, message: impl Into<String>, dry_run: bool, on_conflict: OnConflict, source: SettingSource, ) -> Self

A report for a request that selected nothing or could not run at all.

pub fn summary(&self) -> String

The summary people read: the outcome in words with the non-zero counts, as the CLI prints it under the file lines and R prints it above a result. When the policy acted, that is when a file with local changes or no record was skipped, held back or replaced, a second line names it: on_conflict = <policy> (<source>). A report with a problem says nothing more than the problem, which callers print instead.

pub fn verdict(&self) -> GetVerdict

Whether get did as asked. A skip the policy asked for counts as done.

Trait Implementations

impl Clone for GetReport

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetReport

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

Formats the value using the given formatter.

impl Serialize for GetReport

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.