Struct Edge 

#[non_exhaustive]
pub struct Edge {
    pub from: String,
    pub to: String,
    pub path: String,
    pub kind: Option<EdgeKind>,
    pub basis: Option<KindBasis>,
    pub by_value: bool,
}

One reference, from the object holding it to the object it names.

Built with Edge::new; #[non_exhaustive], so that what ETP adds to an edge is not a breaking change for every caller.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

from: String

URI of the object holding the reference.

to: String

URI of the object it names.

path: String

Where inside the source: Grid2dPatch.SupportingRepresentation.

kind: Option<EdgeKind>

ETP RelationshipKind: whether the reference is primary or secondary - what navigableEdges filters on. None when no rule gives it: an ETP server states it; a store deriving its edges applies the rules of crate::kinds, which refuse by name (basis is then KindBasis::Unknown) where the specification is silent. Never guessed.

basis: Option<KindBasis>

Where kind comes from: stated by a server, a rule of the ETP specification, or this crate’s derivation, each labelled. None for an edge nobody has judged (a reference as written, Edge::new).

by_value: bool

Whether this is a by-value containment (the contained object is the source, its direct container the target; ETP 1.2 section 8.1.1.1.1, p. 156) and not a reference written in the source. It has no path.

Implementations

impl Edge

pub fn new( from: impl Into<String>, to: impl Into<String>, path: impl Into<String>, ) -> Self

A reference whose kind is not stated.

pub fn with_kind(self, kind: EdgeKind) -> Self

With the kind a server states (KindBasis::Stated).

pub fn with_judgement(self, judged: Judged) -> Self

With the kind the rules of crate::kinds give it, and what that rests on. A judgement without a kind leaves the edge unkinded and records why.

pub fn contained(self) -> Self

As a by-value containment (Edge::by_value).

Trait Implementations

impl Clone for Edge

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 Edge

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

Formats the value using the given formatter.

impl Eq for Edge

impl PartialEq for Edge

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Edge