Skip to main content

Report

Struct Report 

Source
pub struct Report {
    pub key_id: [u8; 8],
    pub declared: usize,
    pub encrypted: Vec<PathBuf>,
    pub swept: Vec<PathBuf>,
    pub config_written: bool,
    pub diff_driver_removed: bool,
    pub attributes_written: bool,
    pub key_removed: bool,
    pub warnings: Vec<String>,
}
Expand description

What lock did.

Fields§

§key_id: [u8; 8]

Fingerprint of the key that was removed. Safe to print; the key is not.

§declared: usize

How many working-tree files the declaration selected.

Separate from Report::encrypted so the closing line can tell “nothing to do, everything was already closed” from “nothing matched at all”. The two look identical through a count of files written, and only one of them is a repository that is now safe.

§encrypted: Vec<PathBuf>

Paths, relative to the working tree, that were encrypted in place.

§swept: Vec<PathBuf>

Leftover temporary files that were deleted on the way through.

Reported rather than swallowed: each one may have held a decrypted secret, and a user is entitled to know one was lying around.

§config_written: bool

The filter registration was written or repaired.

§diff_driver_removed: bool

The diff driver was deregistered — which happens on every healthy lock.

Separate from Report::config_written, which means “something was broken and I fixed it”. Merging them made every lock claim a repair.

§attributes_written: bool

The managed .gitattributes section was written or repaired.

§key_removed: bool

The key file is gone.

§warnings: Vec<String>

Anything worth saying once, carried out so the binary owns the messages.

Trait Implementations§

Source§

impl Debug for Report

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Same for T

Source§

type Output = T

Should always be Self
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.