Enum gix_revision::Spec

pub enum Spec {
    Include(ObjectId),
    Exclude(ObjectId),
    Range {
        from: ObjectId,
        to: ObjectId,
    },
    Merge {
        theirs: ObjectId,
        ours: ObjectId,
    },
    IncludeOnlyParents(ObjectId),
    ExcludeParents(ObjectId),
}

A revision specification without any bindings to a repository, useful for serialization or movement over thread boundaries.

Note that all object ids should be a committish, but don’t have to be. Unless the field name contains _exclusive, the respective objects are included in the set.

Variants

Include(ObjectId)

Include commits reachable from this revision, i.e. a and its ancestors.

The equivalent to crate::spec::Kind::IncludeReachable, but with data.

Exclude(ObjectId)

Exclude commits reachable from this revision, i.e. a and its ancestors. Example: ^a.

The equivalent to crate::spec::Kind::ExcludeReachable, but with data.

Range

Fields

from: ObjectId

The starting point of the range, which is included in the set.

to: ObjectId

The end point of the range, which is included in the set.

Every commit that is reachable from from to to, but not any ancestors of from. Example: from..to.

The equivalent to crate::spec::Kind::RangeBetween, but with data.

Merge

Fields

theirs: ObjectId

Their side of the merge, which is included in the set.

ours: ObjectId

Our side of the merge, which is included in the set.

Every commit reachable through either theirs or ours, but no commit that is reachable by both. Example: theirs...ours.

The equivalent to crate::spec::Kind::ReachableToMergeBase, but with data.

IncludeOnlyParents(ObjectId)

Tuple Fields

0: ObjectId

Include only the parents of this object, but not the object itself.

Include every commit of all parents of a, but not a itself. Example: a^@.

The equivalent to crate::spec::Kind::IncludeReachableFromParents, but with data.

ExcludeParents(ObjectId)

Tuple Fields

0: ObjectId

Exclude the parents of this object, but not the object itself.

Exclude every commit of all parents of a, but not a itself. Example: a^!.

The equivalent to crate::spec::Kind::ExcludeReachableFromParents, but with data.

Implementations

impl Spec

pub fn kind(&self) -> Kind

Return the kind of this specification.

Trait Implementations

impl Clone for Spec

fn clone(&self) -> Spec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Spec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Spec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Spec

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

Formats the value using the given formatter.

impl Hash for Spec

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 Ord for Spec

fn cmp(&self, other: &Spec) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Spec

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

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

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

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

impl PartialOrd for Spec

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

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

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

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

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

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

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

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

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

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

impl Serialize for Spec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Spec

impl Eq for Spec

impl StructuralPartialEq for Spec