Struct Comments 

pub struct Comments {
    pub leading: Vec<String>,
    pub trailing: Option<String>,
    pub inner: Vec<String>,
}

Comments associated with a YAML value

Fields

leading: Vec<String>

Comments that appear before this value

trailing: Option<String>

Comment that appears on the same line as this value

inner: Vec<String>

Comments that appear inside collections (between items)

Implementations

impl Comments

pub const fn new() -> Self

Create empty comments

pub const fn is_empty(&self) -> bool

Check if there are any comments

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

Add a leading comment

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

Set the trailing comment

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

Add an inner comment

Trait Implementations

impl Clone for Comments

fn clone(&self) -> Comments

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Comments

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

Formats the value using the given formatter.

impl Default for Comments

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Comments

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

impl StructuralPartialEq for Comments