Struct DependencyEndpoint 

pub struct DependencyEndpoint {
    pub kind: ItemKind,
    /* private fields */
}

One endpoint of a dependency edge.

Three forms: a native id of the source reporting it, a qualified <source>:<native> id, and the opaque form — a Designator naming the tracker that holds the item and the item’s native id there, which names a private item from a public one while conveying nothing about it.

Fields

kind: ItemKind

Whether the endpoint names a task or a project.

Implementations

impl DependencyEndpoint

pub fn new(id: String, kind: ItemKind) -> Result<Self, String>

Builds an endpoint from a serialized id, validating a qualified id when present.

Errors

Returns an error for an empty id or a malformed <source>:<native> id.

pub fn opaque( designator: Designator, id: String, kind: ItemKind, ) -> Result<Self, String>

The opaque endpoint naming id, an item’s native id in the tracker designator names.

Errors

Returns an error for an empty id.

pub fn from_value(value: &Value) -> Result<Self, EndpointRefusal>

Reads an endpoint from any of its three JSON forms, naming what about an object makes it none of them.

Unlike deserialization, which reads what a store already holds, this is for what a caller asks to be written: an object carrying a key beyond designator, id and kind — a title, a team, a URL — is refused with EndpointRefusal::Key naming that key, and never its value.

Errors

EndpointRefusal.

pub fn from_native(id: NativeId, kind: ItemKind) -> Self

Builds an endpoint from a source-native id, whose contents are deliberately opaque.

pub fn id(&self) -> &str

The serialized native or qualified id — for the opaque form, the native id in the tracker Self::designator names.

pub fn into_id(self) -> String

Consumes the endpoint and returns its serialized id.

pub fn is_qualified(&self) -> bool

Whether the id was explicitly supplied as a qualified endpoint.

pub fn source(&self) -> Option<&str>

The source segment of a qualified id, or None for a native or an opaque one.

A native id belongs to whichever source reports it, so None reads as “this source” rather than “no source” — ask Self::is_native before reading it that way, because an opaque endpoint names no source of this configuration either.

pub fn is_native(&self) -> bool

Whether the id is a native id of the source reporting it: neither qualified nor opaque.

pub fn designator(&self) -> Option<&Designator>

The tracker an opaque endpoint names, or None for the other two forms.

Trait Implementations

impl Clone for DependencyEndpoint

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 DependencyEndpoint

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DependencyEndpoint

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DependencyEndpoint

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

Formats the value using the given formatter.

impl Eq for DependencyEndpoint

impl Hash for DependencyEndpoint

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 JsonSchema for DependencyEndpoint

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn json_schema(_generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl PartialEq for DependencyEndpoint

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<NativeId> for DependencyEndpoint

An opaque endpoint names an item of another tracker, so it never equals a native id of the source comparing it, whatever id it holds.

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for DependencyEndpoint

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 DependencyEndpoint