Struct Options

pub struct Options { /* private fields */ }

General diff-related options for configuring rename-tracking and blob diffs.

Implementations

impl Options

Setters

pub fn no_locations(&mut self) -> &mut Self

Do not keep track of filepaths at all, which will leave all location fields empty.

pub fn track_filename(&mut self) -> &mut Self

Keep track of file-names, which makes location fields usable with the filename of the changed item.

pub fn track_path(&mut self) -> &mut Self

Keep track of the entire path of a change, relative to the repository. (default).

This makes the location field fully usable.

pub fn track_rewrites(&mut self, renames: Option<Rewrites>) -> &mut Self

Available on crate feature blob-diff only.

Provide None to disable rewrite tracking entirely, or pass Some(<configuration>) to control to what extent rename and copy tracking is performed.

Note that by default, the git configuration determines rewrite tracking and git defaults are used if nothing is configured, which turns rename tracking with 50% similarity on, while not tracking copies at all.

impl Options

Builder

pub fn with_rewrites(self, renames: Option<Rewrites>) -> Self

Available on crate feature blob-diff only.

Provide None to disable rewrite tracking entirely, or pass Some(<configuration>) to control to what extent rename and copy tracking is performed.

Note that by default, the git configuration determines rewrite tracking and git defaults are used if nothing is configured, which turns rename tracking with 50% similarity on, while not tracking copies at all.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.

impl From<Options> for Options

Available on crate feature blob-diff only.

fn from(opts: Options) -> Self

Converts to this type from the input type.

impl Copy for Options