Struct ExternalIdentity 

pub struct ExternalIdentity {
    pub provider: ExternalProvider,
    pub instance: String,
    pub namespace: Option<String>,
    pub kind: ExternalObjectKind,
    pub external_id: String,
}

Identity of an external object, independent of its display label and URL.

Two references name one object when their ObjectKeys are equal, so equal numbers from different instances, namespaces or number spaces never collide.

Fields

provider: ExternalProvider

Tracker family.

instance: String

Lowercase host[:port] of the hosted or self-hosted instance, without scheme or path.

namespace: Option<String>

Tenant, owner/repository or project namespace where the provider scopes identifiers.

kind: ExternalObjectKind

Object category; it splits identity only between number spaces.

external_id: String

Provider identifier: a number on forges, a PROJECT-N key on Jira and Linear.

Implementations

impl ExternalIdentity

pub fn canonical(&self) -> Self

Normalize spelling that providers treat as equal; validation rejects any other form.

Every rule strips to a fixed point, so canonical is idempotent and the spelling a rejection suggests is always accepted.

pub fn object_key(&self) -> ObjectKey

The key of the object this identity names, computed on its canonical form.

pub fn permits_kind_change_to(&self, next: &Self) -> bool

Whether a record of this identity may be restated with next’s kind: unchanged, or another kind of the same number space unless the record is a pull request. A pull request is the most specific kind of its number, so it is never downgraded; a kind of another number space names another object. Linking and reviewed plan changes both apply this rule.

pub fn refines_kind_of(&self, recorded: &Self) -> bool

Whether this identity names recorded’s object with a kind the record may be restated to.

impl ExternalIdentity

pub fn validate(&self, id: ExternalReferenceId) -> Result<(), ValidationError>

Check that this identity is canonical and structurally valid; commands check a requested identity with this even when it resolves to an existing record.

Trait Implementations

impl Clone for ExternalIdentity

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExternalIdentity

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ExternalIdentity

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ExternalIdentity

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

Formats the value using the given formatter.

impl Eq for ExternalIdentity

impl Hash for ExternalIdentity

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 ExternalIdentity

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 ExternalIdentity

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ExternalIdentity

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 ExternalIdentity

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 ExternalIdentity