Struct CommentedValue 

pub struct CommentedValue {
    pub value: Value,
    pub comments: Comments,
    pub style: Style,
}

A YAML value with optional comments and style for round-trip preservation

Fields

value: Value

The actual YAML value

comments: Comments

Comments associated with this value

style: Style

Style information for formatting preservation

Implementations

impl CommentedValue

pub const fn new(value: Value) -> Self

Create a new commented value

pub fn with_leading_comments(value: Value, comments: Vec<String>) -> Self

Create a commented value with leading comments

pub fn with_trailing_comment(value: Value, comment: String) -> Self

Create a commented value with a trailing comment

pub fn add_leading_comment<S: Into<String>>(&mut self, comment: S)

Add a leading comment

pub fn set_trailing_comment<S: Into<String>>(&mut self, comment: S)

Set a trailing comment

pub const fn has_comments(&self) -> bool

Check if this value has any comments

pub const fn with_quote_style(value: Value, quote_style: QuoteStyle) -> Self

Create a commented value with quote style

pub const fn set_quote_style(&mut self, quote_style: QuoteStyle)

Set the quote style

pub const fn quote_style(&self) -> Option<&QuoteStyle>

Get the quote style

pub const fn has_style(&self) -> bool

Check if this value has style information

pub const fn set_indent_style(&mut self, indent_style: IndentStyle)

Set the indentation style

pub const fn indent_style(&self) -> Option<&IndentStyle>

Get the indentation style

pub const fn with_indent_style(value: Value, indent_style: IndentStyle) -> Self

Create a commented value with indentation style

Trait Implementations

impl Clone for CommentedValue

fn clone(&self) -> CommentedValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommentedValue

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

Formats the value using the given formatter.

impl From<Value> for CommentedValue

fn from(value: Value) -> Self

Converts to this type from the input type.

impl PartialEq for CommentedValue

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

impl StructuralPartialEq for CommentedValue