Struct Comparison 

pub struct Comparison {

    pub base_commit: FullCommit,
    pub merge_base_commit: FullCommit,
    pub head_commit: FullCommit,
    pub status: String,
    pub ahead_by: u32,
    pub behind_by: u32,
    pub total_commits: u32,
    pub commits: Vec<FullCommit>,
    pub files: Vec<FileChange>,
    pub html_url: String,
    pub permalink_url: String,
    pub diff_url: String,
    pub patch_url: String,
    pub url: String,
}

The result of comparing two Git refs (commits, branches, or tags).

Contains the full list of commits between the two refs and every file that changed, together with statistics useful for generating changelogs and release notes.

Examples

let cmp = client.compare_commits("owner", "repo", "v1.0.0", "v1.1.0").await?;
println!("Status: {} ({} ahead, {} behind)",
    cmp.status, cmp.ahead_by, cmp.behind_by);
println!("{} commits, {} files changed",
    cmp.total_commits, cmp.files.len());

Fields

base_commit: FullCommit

The base commit (starting point of the comparison).

merge_base_commit: FullCommit

The common ancestor (merge-base) of the two refs.

head_commit: FullCommit

The head commit (ending point of the comparison).

status: String

Relationship between base and head.

Possible values: "ahead", "behind", "identical", "diverged".

ahead_by: u32

Number of commits the head is ahead of the base.

behind_by: u32

Number of commits the head is behind the base.

total_commits: u32

Total number of commits between base and head.

commits: Vec<FullCommit>

All commits from base to head in chronological order (oldest first).

GitHub limits this to 250 commits.

files: Vec<FileChange>

All files that changed between base and head.

html_url: String

Web interface URL for this comparison.

permalink_url: String

Permalink URL for this comparison.

diff_url: String

URL for the diff view.

patch_url: String

URL for the patch view.

url: String

API URL for this comparison (machine-readable endpoint).

Trait Implementations

impl Clone for Comparison

fn clone(&self) -> Comparison

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Comparison

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Comparison

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Comparison

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

where __S: Serializer,

Serialize this value into the given Serde serializer.