Struct git2::MergeAnalysis

pub struct MergeAnalysis { /* fields omitted */ }

The results of merge_analysis indicating the merge opportunities.

Methods

impl MergeAnalysis

pub const ANALYSIS_NONE: MergeAnalysis

No merge is possible.

pub const ANALYSIS_NORMAL: MergeAnalysis

A "normal" merge; both HEAD and the given merge input have diverged from their common ancestor. The divergent commits must be merged.

pub const ANALYSIS_UP_TO_DATE: MergeAnalysis

All given merge inputs are reachable from HEAD, meaning the repository is up-to-date and no merge needs to be performed.

pub const ANALYSIS_FASTFORWARD: MergeAnalysis

The given merge input is a fast-forward from HEAD and no merge needs to be performed. Instead, the client can check out the given merge input.

pub const ANALYSIS_UNBORN: MergeAnalysis

The HEAD of the current repository is "unborn" and does not point to a valid commit. No merge can be performed, but the caller may wish to simply set HEAD to the target commit(s).

pub const fn empty() -> MergeAnalysis

Returns an empty set of flags

pub const fn all() -> MergeAnalysis

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<MergeAnalysis>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> MergeAnalysis

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> MergeAnalysis

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: MergeAnalysis) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: MergeAnalysis) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: MergeAnalysis)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: MergeAnalysis)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: MergeAnalysis)

Toggles the specified flags in-place.

pub fn set(&mut self, other: MergeAnalysis, value: bool)

Inserts or removes the specified flags depending on the passed value.

impl MergeAnalysis

pub fn is_none(&self) -> bool

pub fn is_normal(&self) -> bool

pub fn is_up_to_date(&self) -> bool

pub fn is_fast_forward(&self) -> bool

pub fn is_unborn(&self) -> bool

Trait Implementations

impl Binary for MergeAnalysis

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

Formats the value using the given formatter.

impl BitAnd<MergeAnalysis> for MergeAnalysis

type Output = MergeAnalysis

The resulting type after applying the & operator.

fn bitand(self, other: MergeAnalysis) -> MergeAnalysis

Returns the intersection between the two sets of flags.

impl BitAndAssign<MergeAnalysis> for MergeAnalysis

fn bitand_assign(&mut self, other: MergeAnalysis)

Disables all flags disabled in the set.

impl BitOr<MergeAnalysis> for MergeAnalysis

type Output = MergeAnalysis

The resulting type after applying the | operator.

fn bitor(self, other: MergeAnalysis) -> MergeAnalysis

Returns the union of the two sets of flags.

impl BitOrAssign<MergeAnalysis> for MergeAnalysis

fn bitor_assign(&mut self, other: MergeAnalysis)

Adds the set of flags.

impl BitXor<MergeAnalysis> for MergeAnalysis

type Output = MergeAnalysis

The resulting type after applying the ^ operator.

fn bitxor(self, other: MergeAnalysis) -> MergeAnalysis

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<MergeAnalysis> for MergeAnalysis

fn bitxor_assign(&mut self, other: MergeAnalysis)

Toggles the set of flags.

impl Clone for MergeAnalysis

fn clone(&self) -> MergeAnalysis

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for MergeAnalysis

impl Debug for MergeAnalysis

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

Formats the value using the given formatter.

impl Eq for MergeAnalysis

impl Extend<MergeAnalysis> for MergeAnalysis

fn extend<T: IntoIterator<Item = MergeAnalysis>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

impl FromIterator<MergeAnalysis> for MergeAnalysis

fn from_iter<T: IntoIterator<Item = MergeAnalysis>>(
    iterator: T
) -> MergeAnalysis

Creates a value from an iterator.

impl Hash for MergeAnalysis

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, 

Feeds a slice of this type into the given [Hasher].

impl LowerHex for MergeAnalysis

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

Formats the value using the given formatter.

impl Not for MergeAnalysis

type Output = MergeAnalysis

The resulting type after applying the ! operator.

fn not(self) -> MergeAnalysis

Returns the complement of this set of flags.

impl Octal for MergeAnalysis

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

Formats the value using the given formatter.

impl Ord for MergeAnalysis

fn cmp(&self, other: &MergeAnalysis) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<MergeAnalysis> for MergeAnalysis

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<MergeAnalysis> for MergeAnalysis

fn partial_cmp(&self, other: &MergeAnalysis) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralEq for MergeAnalysis

impl StructuralPartialEq for MergeAnalysis

impl Sub<MergeAnalysis> for MergeAnalysis

type Output = MergeAnalysis

The resulting type after applying the - operator.

fn sub(self, other: MergeAnalysis) -> MergeAnalysis

Returns the set difference of the two sets of flags.

impl SubAssign<MergeAnalysis> for MergeAnalysis

fn sub_assign(&mut self, other: MergeAnalysis)

Disables all flags enabled in the set.

impl UpperHex for MergeAnalysis

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

Formats the value using the given formatter.