Struct microkelvin::Annotated

pub struct Annotated<C, S>(_, _)
 where
    C: Compound<S>,
    S: Store;

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

Implementations

impl<C, S> Annotated<C, S> where
    C: Compound<S>,
    C::Annotation: Annotation<C, S>,
    S: Store, 

pub fn new(compound: C) -> Self

Create a new annotated type

pub fn annotation(&self) -> &C::Annotation

Returns a reference to to the annotation stored

pub fn val(&self) -> Result<AnnRef<'_, C, S>, S::Error>

Returns an annotated reference to the underlying type

pub fn val_mut(&mut self) -> Result<AnnRefMut<'_, C, S>, S::Error>

Returns a Mutable annotated reference to the underlying type

Trait Implementations

impl<C, S> Canon<S> for Annotated<C, S> where
    C: Compound<S>,
    C::Annotation: Canon<S>,
    S: Store, 

fn write(&self, sink: &mut impl Sink<S>) -> Result<(), S::Error>

Write the value as bytes to a Sink

fn read(source: &mut impl Source<S>) -> Result<Self, S::Error>

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, S: Clone> Clone for Annotated<C, S> where
    C: Compound<S>,
    S: Store,
    C::Annotation: Clone, 

fn clone(&self) -> Annotated<C, S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, S: Debug> Debug for Annotated<C, S> where
    C: Compound<S>,
    S: Store,
    C::Annotation: Debug, 

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

Formats the value using the given formatter.