Struct git2::Sort

pub struct Sort { /* fields omitted */ }

Orderings that may be specified for Revwalk iteration.

Methods

impl Sort

pub const NONE: Sort

Sort the repository contents in no particular ordering.

This sorting is arbitrary, implementation-specific, and subject to change at any time. This is the default sorting for new walkers.

pub const TOPOLOGICAL: Sort

Sort the repository contents in topological order (children before parents).

This sorting mode can be combined with time sorting.

pub const TIME: Sort

Sort the repository contents by commit time.

This sorting mode can be combined with topological sorting.

pub const REVERSE: Sort

Iterate through the repository contents in reverse order.

This sorting mode can be combined with any others.

pub const fn empty() -> Sort

Returns an empty set of flags

pub const fn all() -> Sort

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<Sort>

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) -> Sort

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

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

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: Sort) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

impl Sort

pub fn is_none(&self) -> bool

pub fn is_topological(&self) -> bool

pub fn is_time(&self) -> bool

pub fn is_reverse(&self) -> bool

Trait Implementations

impl Binary for Sort

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

Formats the value using the given formatter.

impl BitAnd<Sort> for Sort

type Output = Sort

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<Sort> for Sort

fn bitand_assign(&mut self, other: Sort)

Disables all flags disabled in the set.

impl BitOr<Sort> for Sort

type Output = Sort

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<Sort> for Sort

fn bitor_assign(&mut self, other: Sort)

Adds the set of flags.

impl BitXor<Sort> for Sort

type Output = Sort

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<Sort> for Sort

fn bitxor_assign(&mut self, other: Sort)

Toggles the set of flags.

impl Clone for Sort

fn clone(&self) -> Sort

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Sort

impl Debug for Sort

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

Formats the value using the given formatter.

impl Eq for Sort

impl Extend<Sort> for Sort

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

Extends a collection with the contents of an iterator.

impl FromIterator<Sort> for Sort

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

Creates a value from an iterator.

impl Hash for Sort

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 Sort

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

Formats the value using the given formatter.

impl Not for Sort

type Output = Sort

The resulting type after applying the ! operator.

fn not(self) -> Sort

Returns the complement of this set of flags.

impl Octal for Sort

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

Formats the value using the given formatter.

impl Ord for Sort

fn cmp(&self, other: &Sort) -> 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<Sort> for Sort

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

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

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

This method tests for !=.

impl PartialOrd<Sort> for Sort

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for Sort

impl StructuralPartialEq for Sort

impl Sub<Sort> for Sort

type Output = Sort

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<Sort> for Sort

fn sub_assign(&mut self, other: Sort)

Disables all flags enabled in the set.

impl UpperHex for Sort

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

Formats the value using the given formatter.