Struct microkelvin::Annotated

pub struct Annotated<C, A>(_, _);

A wrapper type that keeps the annotation of the Compound referenced cached

Implementations

impl<C, A> Annotated<C, A> where
    C: Compound<A>,
    A: Annotation<C::Leaf>, 

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

Create a new annotated type

pub fn annotation(&self) -> &A

Returns a reference to to the annotation stored

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

Returns an annotated reference to the underlying type

pub fn val_mut(&mut self) -> Result<AnnRefMut<'_, C, A>, CanonError> where
    A: Combine<C, A>, 

Returns a Mutable annotated reference to the underlying type

Trait Implementations

impl<C: Canon, A: Canon> Canon for Annotated<C, A>

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, A> Clone for Annotated<C, A>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.