Struct Pattern

pub struct Pattern(/* private fields */);

A Pattern is a QualifiedPattern reference, however, it disallows any references under the refs/rad hierarchy.

Implementations

impl Pattern

pub fn matches(&self, refname: &Qualified<'_>) -> bool

Check if the refname matches the rule’s refspec.

Trait Implementations

impl AsRef<QualifiedPattern<'static>> for Pattern

fn as_ref(&self) -> &QualifiedPattern<'static>

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Pattern

fn clone(&self) -> Pattern

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pattern

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Pattern

fn deserialize<__D>( __deserializer: __D, ) -> Result<Pattern, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Pattern

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

Formats the value using the given formatter.

impl From<Pattern> for QualifiedPattern<'static>

fn from(_: Pattern) -> QualifiedPattern<'static>

Converts to this type from the input type.

impl Ord for Pattern

Patterns are ordered by their specificity.

This is heavily influenced by the evaluation priority of Rules. For a candidate reference name, we want the rule associated with the most specific pattern to apply, i.e. to take priority over all other rules with less specific patterns.

For two patterns φ and ψ, we say that “φ is more specific than ψ”, denoted φ < ψ if:

1. The number of components in φ is larger than the number of components in ψ. (Note that the number of components is equal to the number of occurrences of the symbol ‘/’ in the pattern, plus 1). The justification is, that refnames might be interpreted as a hierarchy where a match on more components would mean a match at a lower level in the hierarchy, thus being more specific. Imagine a refname hierarchy that maps to a corporate hierarchy. The pattern “department-1” matches all refnames that are administered by a particular department, and thus is not very specific. To contrast, the pattern “department-1/team-a/project-i/nice-feature” is very specific as it matches all refnames that relate to the development of a particular feature for a particular project by a particular team. Note that this would also apply when the connection between the φ and ψ is not as obvious, e.g. also a/b/c/d/* < */x.

(Note that for the following items, one may assume that φ and ψ have the same number of components.)

2. If path component i of φ, denoted φ[i], is more specific than path component i of ψ, denoted ψ[i]. This is the case if: a. φ[i] does not contain an asterisk and ψ[i] contains an asterisk, i.e. the symbol *, e.g. a < * and abc < a*. Note that this is important to capture specificity accross components, i.e. to conclude that a/b/* < a/*/c. b. Both φ[i] and ψ[i] contain an asterisk. A. The asterisk in φ[i] is further right than the asterisk in φ[i], e.g. aa* < a*. B. The asterisk in φ[i] and ψ[i] is equally far to the right, and φ[i] is longer than ψ[i], e.g. a*b < a*.

3. Otherwise, fall back to a lexicographic ordering.

Some examples (justification in parentheses):

refs/tags/release/candidates/* <(1.)   refs/tags/release/* <(1.) refs/tags/*
refs/tags/v1.0                 <(2.a.) refs/tags/*
refs/heads/*                   <(3.)   refs/tags/*
refs/heads/main                <(3.)   refs/tags/v1.0

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

Restrict a value to a certain interval.

impl PartialEq for Pattern

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

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

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 PartialOrd for Pattern

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Pattern

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<Qualified<'a>> for Pattern

type Error = PatternError

The type returned in the event of a conversion error.

fn try_from( name: Qualified<'a>, ) -> Result<Pattern, <Pattern as TryFrom<Qualified<'a>>>::Error>

Performs the conversion.

impl<'a> TryFrom<QualifiedPattern<'a>> for Pattern

type Error = PatternError

The type returned in the event of a conversion error.

fn try_from( pattern: QualifiedPattern<'a>, ) -> Result<Pattern, <Pattern as TryFrom<QualifiedPattern<'a>>>::Error>

Performs the conversion.

impl Eq for Pattern

impl StructuralPartialEq for Pattern