Struct SyncSummary 

pub struct SyncSummary { /* private fields */ }

Implementations

impl SyncSummary

pub fn single(msg: MessageIdentifier) -> Self

synced a single message successfully

pub fn new_message_by_id(&self, id: Cursor) -> Option<&MessageIdentifier>

Try to get a newly processed message by its cursor ID

pub fn is_errored(&self) -> bool

Whether the sync operation failed (publish, post-commit, or an unrelated error). This is the single predicate that decides whether a summary may sit in the Err position and which Display branch is used — keep the two in lockstep.

Note: per-message processing failures (process.errored) are deliberately not counted here. A sync that decrypts some messages and fails others is still a successful sync of the group as a whole; those failures are reported inside the summary, not by flipping it to an error.

pub fn add_publish_err(&mut self, e: GroupError)

pub fn add_post_commit_err(&mut self, e: GroupError)

pub fn add_process(&mut self, process: ProcessSummary)

pub fn extend(&mut self, other: SyncSummary)

pub fn other(err: GroupError) -> Self

Construct a sync which failed with an unrelated error.

pub fn add_other(&mut self, err: GroupError)

Trait Implementations

impl Debug for SyncSummary

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

Formats the value using the given formatter.

impl Default for SyncSummary

fn default() -> SyncSummary

Returns the “default value” for a type.

impl Display for SyncSummary

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

Formats the value using the given formatter.

impl Error for SyncSummary

fn source(&self) -> Option<&(dyn Error + 'static)>

Surface the first underlying cause so the error chain (e.g. the FFI Caused by: walk) reaches the real failure instead of dead-ending at the summary’s flattened Display string. Prefer the sync-operation errors, falling back to the first per-message processing error.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<SyncSummary> for CommitLogError

fn from(source: SyncSummary) -> Self

Converts to this type from the input type.

impl From<SyncSummary> for DeviceSyncError

fn from(value: SyncSummary) -> Self

Converts to this type from the input type.

impl From<SyncSummary> for GroupError

fn from(value: SyncSummary) -> Self

Converts to this type from the input type.

impl NeedsDbReconnect for SyncSummary

fn needs_db_reconnect(&self) -> bool

impl RetryableError for SyncSummary

fn is_retryable(&self) -> bool