Enum Ref 

pub enum Ref<T> {
    Reference(String),
    Embedded(Box<T>),
}

An object property’s value: EXACTLY ONE of a reference to a named resource (its canonical URI) or an embedded node (the value itself, carried inline — derived identity, no $id). The typed twin of the wire form’s {"$ref": uri} vs embedded-node distinction; the choice between the arms is authorial and hash-relevant, so it is explicit here, never inferred.

The embedded payload is BOXED (0.6.0, runtime#27). A single-valued property ranging over its own class — a parent/child hierarchy, the most ordinary shape an ontology declares — makes struct Objective { supports: Option<Ref<Objective>> }, which has infinite size if the payload is inline (E0072) and so cannot be generated. The wire form never had that limit; Box is the indirection Rust needs to match it. Construct with Ref::embed / Ref::embed_named and read with Ref::value / Ref::uri and the box is invisible; only a direct Ref::Embedded(x) pattern sees it (Ref::Embedded(b) => &**b).

Variants

Reference(String)

A reference to a named resource by its canonical URI.

Embedded(Box<T>)

An embedded value, carried inline (boxed — see the type’s docs).

Implementations

impl<T> Ref<T>

pub fn to(uri: impl Into<String>) -> Self

A reference to a named resource by its canonical URI.

pub fn to_resource(target: &impl KanonakResource) -> Result<Self, CodecError>

A reference to a named resource by the instance itself — resolved through the target’s envelope id. The target must already carry its identity; an embedded (id-less) value cannot be referenced.

pub fn embed(value: T) -> Self

An embedded value, carried inline (derived identity, no $id).

pub fn embed_named(value: T, name: impl Into<String>) -> Self

where T: KanonakResource,

An embedded value with its authored dict-key name (hash-relevant).

pub fn is_reference(&self) -> bool

True when this is the reference arm.

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

The referenced resource’s canonical URI — the reference arm (else None).

pub fn value(&self) -> Option<&T>

The embedded value — the embedded arm (else None).

pub fn value_mut(&mut self) -> Option<&mut T>

The embedded value, mutably — the embedded arm (else None).

pub fn into_value(self) -> Option<T>

Consume the embedded arm, returning its value (else None).

Trait Implementations

impl<T: Clone> Clone for Ref<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Ref<T>

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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

impl<T: PartialEq> PartialEq for Ref<T>

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

Equality operator ==.

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

Inequality operator !=.

impl<T: Serialize> Serialize for Ref<T>

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<T: PartialEq> StructuralPartialEq for Ref<T>