Struct Resource

pub struct Resource<'a> {
    pub driver_index: Option<usize>,
    pub data: Data<'a>,
    pub mode: EntryKind,
    pub rela_path: &'a BStr,
    pub id: &'a oid,
}

Available on crate feature blob only.

A resource ready to be diffed in one way or another.

Fields

driver_index: Option<usize>

If available, an index into the drivers field to access more diff-related information of the driver for items at the given path, as previously determined by git-attributes.

Note that drivers are queried even if there is no object available.

data: Data<'a>

The data itself, suitable for diffing, and if the object or worktree item is present at all.

mode: EntryKind

The kind of the resource we are looking at. Only possible values are Blob, BlobExecutable and Link.

rela_path: &'a BStr

The location of the resource, relative to the working tree.

id: &'a oid

The id of the content as it would be stored in git, or null if the content doesn’t exist anymore at rela_path or if it was never computed. This can happen with content read from the worktree, which has to go through a filter to be converted back to what git would store.

Implementations

impl<'a> Resource<'a>

pub fn intern_source(&self) -> ByteLines<'a, true>

Produce an iterator over lines, separated by LF or CRLF and thus keeping newlines.

Note that this will cause unusual diffs if a file didn’t end in newline but lines were added on the other side.

Suitable to create tokens using imara_diff::intern::InternedInput.

pub fn intern_source_strip_newline_separators(&self) -> ByteLines<'a, false>

Produce an iterator over lines, but remove LF or CRLF.

This produces the expected diffs when lines were added at the end of a file that didn’t end with a newline before the change.

Suitable to create tokens using imara_diff::intern::InternedInput.

Trait Implementations

impl<'a> Clone for Resource<'a>

fn clone(&self) -> Resource<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Resource<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for Resource<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for Resource<'a>

fn cmp(&self, other: &Resource<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq for Resource<'a>

fn eq(&self, other: &Resource<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> PartialOrd for Resource<'a>

fn partial_cmp(&self, other: &Resource<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Copy for Resource<'a>

impl<'a> Eq for Resource<'a>

impl<'a> StructuralPartialEq for Resource<'a>