Skip to main content

Ref

Enum Ref 

Source
pub enum Ref<T> {
    Reference(String),
    Embedded(T),
}
Expand description

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.

Variants§

§

Reference(String)

A reference to a named resource by its canonical URI.

§

Embedded(T)

An embedded value, carried inline.

Implementations§

Source§

impl<T> Ref<T>

Source

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

A reference to a named resource by its canonical URI.

Source

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.

Source

pub fn embed(value: T) -> Self

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

Source

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).

Source

pub fn is_reference(&self) -> bool

True when this is the reference arm.

Trait Implementations§

Source§

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

Source§

fn clone(&self) -> Ref<T>

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<T: Debug> Debug for Ref<T>

Source§

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

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

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

Source§

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

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

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

Source§

fn eq(&self, other: &Ref<T>) -> bool

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

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

Inequality operator !=. Read more
Source§

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

Source§

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

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

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

Auto Trait Implementations§

§

impl<T> Freeze for Ref<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Ref<T>
where T: RefUnwindSafe,

§

impl<T> Send for Ref<T>
where T: Send,

§

impl<T> Sync for Ref<T>
where T: Sync,

§

impl<T> Unpin for Ref<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Ref<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for Ref<T>
where T: UnwindSafe,

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> 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> 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> Same for T

Source§

type Output = T

Should always be Self
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.