Struct Annotated 

pub(crate) struct Annotated {
    pub(crate) comment: Option<Comment>,
    pub(crate) value: AnnotatedValue,
}

A value decorated with an optional comment.

Fields

comment: Option<Comment>

Comment attached to this value by the author.

value: AnnotatedValue

The annotated value itself.

Implementations

impl Annotated

pub(crate) fn validate(&self, format: Format) -> Result<(), DocumentError>

Check that format can express this value and everything below it.

Backends still check what depends on content, such as a string that a literal block cannot reproduce.

Errors

Returns the unsupported feature error for format, at the path of the first value that needs a feature the format lacks.

impl Annotated

pub(crate) fn mark_generated(&mut self) -> Result<(), TextError>

Put the generated marker in front of the comment of this value.

pub(crate) fn carries_comment(&self) -> bool

Whether this value or any value below it has a comment.

Trait Implementations

impl Clone for Annotated

fn clone(&self) -> Annotated

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Annotated

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

Formats the value using the given formatter.

impl TryFrom<&Value> for Annotated

fn try_from(value: &Value) -> Result<Self, Self::Error>

Decode a generic structured value into its annotation tree.

Errors

Returns an error for malformed annotation markers, fields set more than once, a string style on a non string value, non finite numbers, and value kinds without a scalar counterpart.

type Error = DocumentError

The type returned in the event of a conversion error.