Enum CoReference 

#[non_exhaustive]
pub enum CoReference<T> {
    Weak(T),
}

Wrapps a reference/link/Cid and applies attributes useful in context of a Co.

• A CoReference should be encoded with crate::KnownMultiCodec::CoReference.
• A CoReference should be used with a narrow scope so that only the links to it are moved around.
• A CoReference should be used for cross Co references to state and heads as this has special semantics for example encryption mapping.

FAQ

When to use CoReference::Weak and when [co_primitives::WeakCid]?

Use CoReference::Weak when you want to reference a root. When the garbage collection reaches a CoReference::Weak it will not try to keep it alve with its parent. Example: Keeping a historic root for reference or fast traversing.

Use [co_primitives::WeakCid] when the reference should not been handled as a link and will not be accessed/traversed using this reference.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Weak(T)

Handle the reference as a weak reference. Used for reference counting.

Implementations

impl<T> CoReference<T>

pub fn into_value(self) -> T

pub fn to_block(&self) -> Result<Block, BlockSerializerError>

where T: Serialize,

Trait Implementations

impl<T> AsRef<T> for CoReference<T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Clone> Clone for CoReference<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for CoReference<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for CoReference<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Hash> Hash for CoReference<T>

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<T: Ord> Ord for CoReference<T>

fn cmp(&self, other: &CoReference<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for CoReference<T>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd> PartialOrd for CoReference<T>

fn partial_cmp(&self, other: &CoReference<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Serialize for CoReference<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Eq> Eq for CoReference<T>

impl<T> StructuralPartialEq for CoReference<T>