Skip to main content

EditFix

Enum EditFix 

Source
pub enum EditFix {
    MoveHistoryToFront,
    DeclareCustomAttribute {
        key: String,
    },
    DropDuplicateKey {
        key: String,
        kept: String,
    },
    RemoveRetiredLinksKey {
        key: String,
    },
    RestoreTitle {
        title: String,
    },
}
Expand description

A machine-applicable repair.

“Machine-applicable” is the whole bar: a fix is only offered when tix can perform it without guessing at what the author meant. Prose problems get no fix, only a proposal, because a tool that rewrites a user’s words is worse than one that says “here is the file, fix it”.

Variants§

§

MoveHistoryToFront

Move the misplaced ## History heading and its whole entry block to the top of the body, byte-for-byte.

§

DeclareCustomAttribute

Declare key in tix.toml’s [custom_attributes]. Applied by the app (it writes tix.toml), not by rewriting the issue file.

Fields

§

DropDuplicateKey

Drop the later occurrence of key, keeping the first.

Fields

§kept: String
§

RemoveRetiredLinksKey

Remove the retired links: key and its block.

Fields

§

RestoreTitle

Put the pre-edit title back.

Fields

§title: String

Implementations§

Source§

impl EditFix

Source

pub fn label(&self) -> String

The human description of what applying the fix does.

Source

pub const fn is_text_fix(&self) -> bool

Whether the fix is a rewrite of the issue text, as opposed to an action the app performs elsewhere (declaring a key writes tix.toml).

Source

pub fn apply(&self, contents: &str) -> Option<String>

Apply the fix to contents, returning the repaired text.

None when the fix cannot be applied — the declared-key fix is not a text edit at all, and the text fixes refuse rather than guess when the shape they expect is absent. A None means the caller must leave the file untouched.

Trait Implementations§

Source§

impl Clone for EditFix

Source§

fn clone(&self) -> Self

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 EditFix

Source§

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

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

impl Eq for EditFix

Source§

impl PartialEq for EditFix

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for EditFix

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> 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 = !

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.