Enum RelationKind 

pub enum RelationKind {
    Blocks,
    BlockedBy,
    Duplicates,
    Related,
}

The closed vocabulary of typed relations.

Exactly four kinds ship in this mission (decision 01M3BXC5P4MK0BYECA3K1B9Z82). The set is compiled in — there is no configuration key — and an unknown kind is rejected rather than coerced.

Variants

Blocks

The source issue blocks the target issue. The canonical stored form of a blocking relationship.

BlockedBy

The source issue is blocked by the target issue. An input spelling only: it normalizes into the equivalent RelationKind::Blocks edge and is never persisted.

Duplicates

The source issue duplicates the target issue. No blocked-state effect.

Related

Explicit non-directional association. Stored once, never mirrored, and the only non-directional kind.

Implementations

impl RelationKind

pub const ALL: [RelationKind; 4]

Every kind in the closed vocabulary, in canonical spell order.

pub fn as_str(self) -> &'static str

The canonical lowercase spelling used in files and CLI output.

pub fn is_directional(self) -> bool

Whether the kind has a direction. False only for RelationKind::Related.

pub fn inverse(self) -> Option<Self>

The kind that describes the same edge seen from the other endpoint.

Blocks ↔ BlockedBy; Duplicates and Related have no inverse because neither mirrors.

Trait Implementations

impl Clone for RelationKind

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RelationKind

impl Debug for RelationKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RelationKind

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RelationKind

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

Formats the value using the given formatter.

impl Eq for RelationKind

impl FromStr for RelationKind

fn from_str(s: &str) -> Result<Self, Self::Err>

Parse a canonical kind spelling, rejecting anything outside the closed vocabulary with an DiagnosticKind::UnknownKind diagnostic. An unknown kind is never coerced to related.

type Err = Diagnostic

The associated error which can be returned from parsing.

impl Hash for RelationKind

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 RelationKind

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for RelationKind

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for RelationKind

fn partial_cmp(&self, other: &Self) -> 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 RelationKind

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RelationKind