Skip to main content

FileOutcome

Struct FileOutcome 

Source
pub struct FileOutcome {
    pub file: PathBuf,
    pub applied: Vec<Applied>,
    pub skipped: Vec<Skipped>,
    pub deferred: usize,
    pub reverted: Option<String>,
    pub oscillation: Option<String>,
    pub contents: Option<String>,
    pub suggested: Option<String>,
    pub check: CheckInfo,
}
Expand description

Everything one file’s run of fix_file did, and everything it declined to do.

A run that changed nothing still fills this in: the skips are the answer to “why did htl fix do nothing”, and without them a filtered run and a clean file look alike.

Fields§

§file: PathBuf

The file this is about.

§applied: Vec<Applied>

Fixes that landed, in the order the passes applied them.

§skipped: Vec<Skipped>

Fixes that did not, each with its reason.

§deferred: usize

Edits deferred because they overlapped an applied one and the pass cap hit.

§reverted: Option<String>

The file was put back as it was because a fix introduced an error.

§oscillation: Option<String>

Two passes produced the same edit set: the rules named undo each other.

§contents: Option<String>

The new contents (dry run: what would be written); None when unchanged.

§suggested: Option<String>

The file as the suggest fixes would additionally leave it, over whatever was applied. Never written: a suggestion is shown and the value in it is the author’s to choose (htl fix --diff is where it is shown). None when there are none.

§check: CheckInfo

Diagnostics after the last pass (what htl check would now say).

Trait Implementations§

Source§

impl Debug for FileOutcome

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for FileOutcome

Source§

fn default() -> FileOutcome

Returns the “default value” for a type. 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> MaybeSend for T

Source§

impl<T> MaybeSync for T

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.