Struct microkelvin::Link

pub struct Link<C, A> { /* fields omitted */ }

TODO

Implementations

impl<C, A> Link<C, A> where
    C: Compound<A>,
    C::Leaf: Canon,
    A: Canon, 

pub fn new(compound: C) -> Self where
    A: Annotation<C::Leaf>, 

Create a new link

pub fn new_persisted(id: Id, annotation: A) -> Self

Creates a new link from an id and annotation

pub fn annotation(&self) -> LinkAnnotation<'_, C, A> where
    A: Annotation<C::Leaf>, 

Returns a reference to to the annotation stored

pub fn into_compound(self) -> Result<C, CanonError> where
    C::Leaf: Canon, 

Gets a reference to the inner compound of the link’

Can fail when trying to fetch data over i/o

pub fn id(&self) -> Id where
    C::Leaf: Canon,
    A: Annotation<C::Leaf>, 

Computes the Id of the

pub fn compound(&self) -> Result<LinkCompound<'_, C, A>, CanonError>

Gets a reference to the inner compound of the link’

Can fail when trying to fetch data over i/o

pub fn compound_mut(&mut self) -> Result<LinkCompoundMut<'_, C, A>, CanonError> where
    C: Canon, 

Returns a Mutable reference to the underlying compound node

Drops cached annotations and ids

Can fail when trying to fetch data over i/o

Trait Implementations

impl<C, A> Canon for Link<C, A> where
    C: Compound<A> + Canon,
    C::Leaf: Canon,
    A: Annotation<C::Leaf>, 

fn encode(&self, sink: &mut Sink<'_>)

Write the value as bytes to a Sink

fn decode(source: &mut Source<'_>) -> Result<Self, CanonError>

Read the value from bytes in a Source

fn encoded_len(&self) -> usize

Returns the number of bytes needed to encode this value

impl<C: Clone, A: Clone> Clone for Link<C, A>

fn clone(&self) -> Link<C, A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, A: Debug> Debug for Link<C, A>

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

Formats the value using the given formatter.