Struct Location

#[non_exhaustive]
pub struct Location {
    pub file_path: Option<String>,
    pub file_position: Option<i64>,
    pub relative_file_version: Option<RelativeFileVersionEnum>,
}

Returns information about the location of a change or comment in the comparison between two commits or a pull request.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

file_path: Option<String>

The name of the file being compared, including its extension and subdirectory, if any.

file_position: Option<i64>

The position of a change in a compared file, in line number format.

relative_file_version: Option<RelativeFileVersionEnum>

In a comparison of commits or a pull request, whether the change is in the before or after of that comparison.

Implementations

impl Location

pub fn file_path(&self) -> Option<&str>

The name of the file being compared, including its extension and subdirectory, if any.

pub fn file_position(&self) -> Option<i64>

The position of a change in a compared file, in line number format.

pub fn relative_file_version(&self) -> Option<&RelativeFileVersionEnum>

In a comparison of commits or a pull request, whether the change is in the before or after of that comparison.

impl Location

pub fn builder() -> LocationBuilder

Creates a new builder-style object to manufacture Location.

Trait Implementations

impl Clone for Location

fn clone(&self) -> Location

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Location

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

Formats the value using the given formatter.

impl PartialEq for Location

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

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

const 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 StructuralPartialEq for Location