Struct Annotation

pub struct Annotation(pub Box<AnnotationInner>);

Annotation Type: A text note which also contains information about who made the statement and when.

Annotation v5.0.0

Text node with attribution

A text note which also contains information about who made the statement and when.

For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate “modifying” information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).

Tuple Fields

0: Box<AnnotationInner>

Implementations

impl Annotation

pub fn builder() -> AnnotationBuilder

Start building an instance.

Trait Implementations

impl Clone for Annotation

fn clone(&self) -> Annotation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Annotation

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

Formats the value using the given formatter.

impl Deref for Annotation

type Target = AnnotationInner

The resulting type after dereferencing.

fn deref(&self) -> &<Annotation as Deref>::Target

Dereferences the value.

impl DerefMut for Annotation

fn deref_mut(&mut self) -> &mut <Annotation as Deref>::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for Annotation

fn deserialize<__D>( __deserializer: __D, ) -> Result<Annotation, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<AnnotationInner> for Annotation

fn from(inner: AnnotationInner) -> Annotation

Converts to this type from the input type.

impl PartialEq for Annotation

fn eq(&self, other: &Annotation) -> 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 Serialize for Annotation

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Annotation