Struct CodebaseDiff

Source
pub struct CodebaseDiff { /* private fields */ }
Expand description

Represents the differences between two states of a codebase, typically used for incremental analysis.

It tracks symbols/members to keep, those whose signatures changed but bodies might be reusable, added/deleted symbols/members, and detailed text diff/deletion ranges per file. Provides a comprehensive API for modification and querying following established conventions.

Implementations§

Source§

impl CodebaseDiff

Source

pub fn new() -> Self

Source

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

Merges changes from another CodebaseDiff into this one.

Source

pub fn get_keep(&self) -> &HashSet<SymbolIdentifier>

Returns a reference to the set of symbols/members to keep unchanged.

Source

pub fn get_keep_signature(&self) -> &HashSet<SymbolIdentifier>

Returns a reference to the set of symbols/members whose signatures can be kept.

Source

pub fn get_add_or_delete(&self) -> &HashSet<SymbolIdentifier>

Returns a reference to the set of added or deleted symbols/members.

Source

pub fn get_diff_map( &self, ) -> &HashMap<FileId, Vec<(usize, usize, isize, isize)>>

Returns a reference to the map of source files to text diff hunks.

Source

pub fn get_deletion_ranges_map(&self) -> &HashMap<FileId, Vec<(usize, usize)>>

Returns a reference to the map of source files to deletion ranges.

Source

pub fn set_keep(&mut self, keep_set: impl IntoIterator<Item = SymbolIdentifier>)

Sets the ‘keep’ set, replacing the existing one.

Source

pub fn with_keep( self, keep_set: impl IntoIterator<Item = SymbolIdentifier>, ) -> Self

Returns a new instance with the ‘keep’ set replaced.

Source

pub fn add_keep_entry(&mut self, entry: SymbolIdentifier) -> bool

Adds a single entry to the ‘keep’ set. Returns true if the entry was not already present.

Source

pub fn with_added_keep_entry(self, entry: SymbolIdentifier) -> Self

Returns a new instance with the entry added to the ‘keep’ set.

Source

pub fn add_keep_entries( &mut self, entries: impl IntoIterator<Item = SymbolIdentifier>, )

Adds multiple entries to the ‘keep’ set.

Source

pub fn with_added_keep_entries( self, entries: impl IntoIterator<Item = SymbolIdentifier>, ) -> Self

Returns a new instance with multiple entries added to the ‘keep’ set.

Source

pub fn unset_keep(&mut self)

Clears the ‘keep’ set.

Source

pub fn without_keep(self) -> Self

Returns a new instance with an empty ‘keep’ set.

Source

pub fn set_keep_signature( &mut self, keep_set: impl IntoIterator<Item = SymbolIdentifier>, )

Sets the ‘keep_signature’ set, replacing the existing one.

Source

pub fn with_keep_signature( self, keep_set: impl IntoIterator<Item = SymbolIdentifier>, ) -> Self

Returns a new instance with the ‘keep_signature’ set replaced.

Source

pub fn add_keep_signature_entry(&mut self, entry: SymbolIdentifier) -> bool

Adds a single entry to the ‘keep_signature’ set. Returns true if the entry was not already present.

Source

pub fn with_added_keep_signature_entry(self, entry: SymbolIdentifier) -> Self

Returns a new instance with the entry added to the ‘keep_signature’ set.

Source

pub fn add_keep_signature_entries( &mut self, entries: impl IntoIterator<Item = SymbolIdentifier>, )

Adds multiple entries to the ‘keep_signature’ set.

Source

pub fn with_added_keep_signature_entries( self, entries: impl IntoIterator<Item = SymbolIdentifier>, ) -> Self

Returns a new instance with multiple entries added to the ‘keep_signature’ set.

Source

pub fn unset_keep_signature(&mut self)

Clears the ‘keep_signature’ set.

Source

pub fn without_keep_signature(self) -> Self

Returns a new instance with an empty ‘keep_signature’ set.

Source

pub fn set_add_or_delete( &mut self, change_set: impl IntoIterator<Item = SymbolIdentifier>, )

Sets the ‘add_or_delete’ set, replacing the existing one.

Source

pub fn with_add_or_delete( self, change_set: impl IntoIterator<Item = SymbolIdentifier>, ) -> Self

Returns a new instance with the ‘add_or_delete’ set replaced.

Source

pub fn add_add_or_delete_entry(&mut self, entry: SymbolIdentifier) -> bool

Adds a single entry to the ‘add_or_delete’ set. Returns true if the entry was not already present.

Source

pub fn contains_add_or_delete_entry(&self, entry: &SymbolIdentifier) -> bool

Checks if the ‘add_or_delete’ set contains a specific entry.

Source

pub fn with_added_add_or_delete_entry(self, entry: SymbolIdentifier) -> Self

Returns a new instance with the entry added to the ‘add_or_delete’ set.

Source

pub fn add_add_or_delete_entries( &mut self, entries: impl IntoIterator<Item = SymbolIdentifier>, )

Adds multiple entries to the ‘add_or_delete’ set.

Source

pub fn with_added_add_or_delete_entries( self, entries: impl IntoIterator<Item = SymbolIdentifier>, ) -> Self

Returns a new instance with multiple entries added to the ‘add_or_delete’ set.

Source

pub fn unset_add_or_delete(&mut self)

Clears the ‘add_or_delete’ set.

Source

pub fn without_add_or_delete(self) -> Self

Returns a new instance with an empty ‘add_or_delete’ set.

Source

pub fn set_diff_map( &mut self, map: HashMap<FileId, Vec<(usize, usize, isize, isize)>>, )

Sets the diff map, replacing the existing one.

Source

pub fn with_diff_map( self, map: HashMap<FileId, Vec<(usize, usize, isize, isize)>>, ) -> Self

Returns a new instance with the diff map replaced.

Source

pub fn add_diff_map_entry( &mut self, source: FileId, diffs: Vec<(usize, usize, isize, isize)>, ) -> Option<Vec<(usize, usize, isize, isize)>>

Adds or replaces the diff hunks for a specific source file. Returns previous hunks if any.

Source

pub fn with_added_diff_map_entry( self, source: FileId, diffs: Vec<(usize, usize, isize, isize)>, ) -> Self

Returns a new instance with the diff hunks for the source file added or updated.

Source

pub fn add_diffs_for_source( &mut self, source: FileId, diffs: impl IntoIterator<Item = (usize, usize, isize, isize)>, )

Extends the diff hunks for a specific source file.

Source

pub fn with_added_diffs_for_source( self, source: FileId, diffs: impl IntoIterator<Item = (usize, usize, isize, isize)>, ) -> Self

Returns a new instance with the diff hunks for the source file extended.

Source

pub fn unset_diff_map(&mut self)

Clears the diff map.

Source

pub fn without_diff_map(self) -> Self

Returns a new instance with an empty diff map.

Source

pub fn set_deletion_ranges_map( &mut self, map: HashMap<FileId, Vec<(usize, usize)>>, )

Sets the deletion ranges map, replacing the existing one.

Source

pub fn with_deletion_ranges_map( self, map: HashMap<FileId, Vec<(usize, usize)>>, ) -> Self

Returns a new instance with the deletion ranges map replaced.

Source

pub fn add_deletion_ranges_entry( &mut self, source: FileId, ranges: Vec<(usize, usize)>, ) -> Option<Vec<(usize, usize)>>

Adds or replaces the deletion ranges for a specific source file. Returns previous ranges if any.

Source

pub fn with_added_deletion_ranges_entry( self, file: FileId, ranges: Vec<(usize, usize)>, ) -> Self

Returns a new instance with the deletion ranges for the source file added or updated.

Source

pub fn add_deletion_ranges_for_source( &mut self, file: FileId, ranges: impl IntoIterator<Item = (usize, usize)>, )

Extends the deletion ranges for a specific source file.

Source

pub fn with_added_deletion_ranges_for_source( self, file: FileId, ranges: impl IntoIterator<Item = (usize, usize)>, ) -> Self

Returns a new instance with the deletion ranges for the source file extended.

Source

pub fn unset_deletion_ranges_map(&mut self)

Clears the deletion ranges map.

Source

pub fn without_deletion_ranges_map(self) -> Self

Returns a new instance with an empty deletion ranges map.

Trait Implementations§

Source§

impl Clone for CodebaseDiff

Source§

fn clone(&self) -> CodebaseDiff

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CodebaseDiff

Source§

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

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

impl Default for CodebaseDiff

Source§

fn default() -> CodebaseDiff

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for CodebaseDiff

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for CodebaseDiff

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for CodebaseDiff

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for CodebaseDiff

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> 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> Paint for T
where T: ?Sized,

Source§

fn fg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the foreground set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like red() and green(), which have the same functionality but are pithier.

§Example

Set foreground color to white using fg():

use yansi::{Paint, Color};

painted.fg(Color::White);

Set foreground color to white using white().

use yansi::Paint;

painted.white();
Source§

fn primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example
println!("{}", value.primary());
Source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example
println!("{}", value.fixed(color));
Source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example
println!("{}", value.rgb(r, g, b));
Source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example
println!("{}", value.black());
Source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example
println!("{}", value.red());
Source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example
println!("{}", value.green());
Source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example
println!("{}", value.yellow());
Source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example
println!("{}", value.blue());
Source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example
println!("{}", value.magenta());
Source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example
println!("{}", value.cyan());
Source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example
println!("{}", value.white());
Source§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlack].

§Example
println!("{}", value.bright_black());
Source§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightRed].

§Example
println!("{}", value.bright_red());
Source§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightGreen].

§Example
println!("{}", value.bright_green());
Source§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightYellow].

§Example
println!("{}", value.bright_yellow());
Source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example
println!("{}", value.bright_blue());
Source§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.bright_magenta());
Source§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightCyan].

§Example
println!("{}", value.bright_cyan());
Source§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightWhite].

§Example
println!("{}", value.bright_white());
Source§

fn bg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the background set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like on_red() and on_green(), which have the same functionality but are pithier.

§Example

Set background color to red using fg():

use yansi::{Paint, Color};

painted.bg(Color::Red);

Set background color to red using on_red().

use yansi::Paint;

painted.on_red();
Source§

fn on_primary(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Primary].

§Example
println!("{}", value.on_primary());
Source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example
println!("{}", value.on_fixed(color));
Source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
Source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example
println!("{}", value.on_black());
Source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example
println!("{}", value.on_red());
Source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example
println!("{}", value.on_green());
Source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example
println!("{}", value.on_yellow());
Source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example
println!("{}", value.on_blue());
Source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example
println!("{}", value.on_magenta());
Source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example
println!("{}", value.on_cyan());
Source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example
println!("{}", value.on_white());
Source§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlack].

§Example
println!("{}", value.on_bright_black());
Source§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightRed].

§Example
println!("{}", value.on_bright_red());
Source§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightGreen].

§Example
println!("{}", value.on_bright_green());
Source§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
Source§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlue].

§Example
println!("{}", value.on_bright_blue());
Source§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
Source§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightCyan].

§Example
println!("{}", value.on_bright_cyan());
Source§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightWhite].

§Example
println!("{}", value.on_bright_white());
Source§

fn attr(&self, value: Attribute) -> Painted<&T>

Enables the styling Attribute value.

This method should be used rarely. Instead, prefer to use attribute-specific builder methods like bold() and underline(), which have the same functionality but are pithier.

§Example

Make text bold using attr():

use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);

Make text bold using using bold().

use yansi::Paint;

painted.bold();
Source§

fn bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example
println!("{}", value.bold());
Source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example
println!("{}", value.dim());
Source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example
println!("{}", value.italic());
Source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example
println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

§Example
println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example
println!("{}", value.rapid_blink());
Source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example
println!("{}", value.invert());
Source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example
println!("{}", value.conceal());
Source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example
println!("{}", value.strike());
Source§

fn quirk(&self, value: Quirk) -> Painted<&T>

Enables the yansi Quirk value.

This method should be used rarely. Instead, prefer to use quirk-specific builder methods like mask() and wrap(), which have the same functionality but are pithier.

§Example

Enable wrapping using .quirk():

use yansi::{Paint, Quirk};

painted.quirk(Quirk::Wrap);

Enable wrapping using wrap().

use yansi::Paint;

painted.wrap();
Source§

fn mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example
println!("{}", value.mask());
Source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example
println!("{}", value.wrap());
Source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example
println!("{}", value.linger());
Source§

fn clear(&self) -> Painted<&T>

👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear(). The clear() method will be removed in a future release.

Returns self with the quirk() set to [Quirk :: Clear].

§Example
println!("{}", value.clear());
Source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example
println!("{}", value.resetting());
Source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example
println!("{}", value.bright());
Source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example
println!("{}", value.on_bright());
Source§

fn whenever(&self, value: Condition) -> Painted<&T>

Conditionally enable styling based on whether the Condition value applies. Replaces any previous condition.

See the crate level docs for more details.

§Example

Enable styling painted only when both stdout and stderr are TTYs:

use yansi::{Paint, Condition};

painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
Source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. 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 = 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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,