Skip to main content

RelationKind

Enum RelationKind 

Source
pub enum RelationKind {
    Semantic(SemanticSubKind),
    OpenPredicate,
    Traversal,
    Containment(ContainmentSubKind),
    Arrangement(ArrangementSubKind),
    Imported(ImportedSubKind),
    Provenance(ProvenanceSubKind),
}
Expand description

Canonical read-side classifier for an edge’s relation. Combines family + sub-kind into one enum that callers reaching for “what kind of relation is this?” can match on without touching the write-side EdgeAssertion payload.

Per the 2026-05-11 relation-taxonomy plan §3: RelationKind is the discriminant shape (RelationKind ≈ discriminant(EdgeAssertion)), used by canvas hit-tests, render policy, filter UIs, action-target inference, and view-local hide keys. EdgeAssertion remains the write contract — it carries construction-time payload (labels, decay state, etc.) that read sites don’t need.

Traversal is the one variant without a sub-kind: traversal is event-shaped, with temporal nuance in NavigationTrigger rather than a TraversalSubKind enum.

OpenPredicate is a Semantic statement whose predicate IRI has no recognized SemanticSubKind (minted by assert_semantic_predicate / JSON-LD ingest). It exists so relations() emits one row per statement, matching has_relation(Family(Semantic)) (Q1 ruling, 2026-09-12). The IRI is reached through the typed payload (semantic_statements()), not carried on the row, so the kind stays Copy.

Variants§

§

Semantic(SemanticSubKind)

§

OpenPredicate

§

Traversal

§

Containment(ContainmentSubKind)

§

Arrangement(ArrangementSubKind)

§

Imported(ImportedSubKind)

§

Provenance(ProvenanceSubKind)

Implementations§

Source§

impl RelationKind

Source

pub fn predicate_iri(self) -> Option<&'static str>

The canonical predicate IRI for a recognized relation kind.

Semantic predicates retain their established byte-for-byte IRIs. The other sub-kind families use an explicit family-qualified local name so their predicate identity is stable across refactors. Traversal and open predicates do not name one fixed predicate here.

Source

pub fn from_predicate_iri(iri: &str) -> Option<Self>

Decode a canonical predicate IRI produced by Self::predicate_iri. Unknown and open predicates remain outside the closed relation-kind vocabulary.

Source

pub fn family(self) -> EdgeFamily

Project to the relation’s family. Pure function — no payload access required.

Source

pub fn tag(self) -> u32

Encode this relation as an opaque u32 tag for transport through layers that can’t depend on kernel (e.g. graph-canvas::CanvasEdge::tag / HitProxy::Edge::tag). The top byte is the family ordinal (0..5); the bottom three bytes are the sub-kind ordinal within the family. OpenPredicate keeps the Semantic family byte and uses the all-ones sub-ordinal ([OPEN_PREDICATE_TAG_SUB]) as its sentinel, so a consumer that reads only the family byte still sees Semantic. Self::from_tag is the inverse.

Source

pub fn from_tag(tag: u32) -> Option<Self>

Decode a u32 tag produced by Self::tag. Returns None for tags that don’t correspond to a known relation (unknown family byte or sub-kind ordinal out of range).

Trait Implementations§

Source§

impl Archive for RelationKind

Source§

type Archived = ArchivedRelationKind

The archived representation of this type. Read more
Source§

type Resolver = RelationKindResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.
Source§

fn resolve( &self, resolver: <Self as Archive>::Resolver, out: Place<<Self as Archive>::Archived>, )

Creates the archived version of this value at the given position and writes it to the given output. Read more
Source§

const COPY_OPTIMIZATION: CopyOptimization<Self> = _

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize. Read more
Source§

impl Clone for RelationKind

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for RelationKind

Source§

impl Debug for RelationKind

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<__D: Fallible + ?Sized> Deserialize<RelationKind, __D> for Archived<RelationKind>

Source§

fn deserialize( &self, deserializer: &mut __D, ) -> Result<RelationKind, <__D as Fallible>::Error>

Deserializes using the given deserializer
Source§

impl Eq for RelationKind

Source§

impl Hash for RelationKind

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for RelationKind

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for RelationKind

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl<__S: Fallible + ?Sized> Serialize<__S> for RelationKind

Source§

fn serialize( &self, serializer: &mut __S, ) -> Result<<Self as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.
Source§

impl StructuralPartialEq for RelationKind

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<T> ArchiveUnsized for T
where T: Archive,

Source§

type Archived = <T as Archive>::Archived

The archived counterpart of this type. Unlike Archive, it may be unsized. Read more
Source§

fn archived_metadata( &self, ) -> <<T as ArchiveUnsized>::Archived as ArchivePointee>::ArchivedMetadata

Creates the archived version of the metadata for this value.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> EntryIdentityKey for T
where T: Clone + Eq + Hash + Debug + Serialize + for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T> MemoryPayload for T
where T: Clone + Debug + Serialize + for<'de> Deserialize<'de>,

Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> OwnerIdentity for T
where T: Clone + Eq + Hash + Debug + Serialize + for<'de> Deserialize<'de>,

Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T, S> SerializeUnsized<S> for T
where T: Serialize<S>, S: Fallible + Writer + ?Sized,

Source§

fn serialize_unsized( &self, serializer: &mut S, ) -> Result<usize, <S as Fallible>::Error>

Writes the object and returns the position of the archived type.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.