Skip to main content

RestoreReport

Struct RestoreReport 

Source
pub struct RestoreReport {
Show 13 fields pub dest: PathBuf, pub manifest: Manifest, pub dry_run: bool, pub entries_written: u64, pub destination_exists: bool, pub would_overwrite: Vec<String>, pub would_remain: Vec<String>, pub rewritten_worktrees: Vec<String>, pub missing_worktrees: Vec<String>, pub dangling_symlinks: Vec<SymlinkRecord>, pub missing_claude_link_roots: Vec<String>, pub regenerable_caches: Vec<SkipRecord>, pub secrets_not_carried: Vec<SkipRecord>,
}
Expand description

What restore did — or, on a dry run, what it would do.

Fields§

§dest: PathBuf

Where the project was restored, or would be.

§manifest: Manifest

Manifest read from the archive.

§dry_run: bool

Whether this was a prediction rather than a restore.

§entries_written: u64

Number of entries written, or that would be written.

§destination_exists: bool

Whether the destination already exists.

Only meaningful on a dry run; a real restore either refused or was given force.

§would_overwrite: Vec<String>

Existing files the restore would replace.

Populated on a dry run only. Empty when the destination is new.

§would_remain: Vec<String>

Existing files the pack does not carry, which would survive the restore.

This is the concrete form of “--force overwrites, it does not wipe”: everything listed here is still there afterwards. Populated on a dry run only.

§rewritten_worktrees: Vec<String>

Worktrees whose pointer files were rewritten for the new location.

§missing_worktrees: Vec<String>

Worktrees that were registered at pack time but live outside the root, so their contents are not in the pack.

§dangling_symlinks: Vec<SymlinkRecord>

Restored symlinks whose targets do not exist on this machine.

§missing_claude_link_roots: Vec<String>

.claude/ link roots that are absent here, if any.

§regenerable_caches: Vec<SkipRecord>

Cache directories the pack deliberately dropped; regenerate as needed.

§secrets_not_carried: Vec<SkipRecord>

Secrets the pack deliberately did not carry; move them out of band.

Implementations§

Source§

impl RestoreReport

Source

pub fn needs_attention(&self) -> bool

Whether anything needs operator attention after the restore.

On a dry run this reads as “would need attention”, and additionally counts a destination that already holds files: proceeding there needs --force, and whatever the pack does not carry stays behind.

Trait Implementations§

Source§

impl Clone for RestoreReport

Source§

fn clone(&self) -> RestoreReport

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RestoreReport

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more