Struct Comment 

pub struct Comment { /* private fields */ }

Comment text attached to a LocatedValue: lines preceding the key and an optional inline comment on the same line as the value.

Empty by default — callers check .before().is_empty() and .after() to detect absence.

Implementations

impl Comment

pub fn new() -> Self

pub fn before(&self) -> &[String]

Comment lines preceding the key; empty when none.

pub fn before_mut(&mut self) -> &mut Vec<String>

pub fn after(&self) -> Option<&str>

Inline comment on the same line as the value; None when absent.

pub fn after_mut(&mut self) -> &mut Option<String>

pub fn with_before( self, lines: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Builder: set the before-lines (replaces any existing).

pub fn with_after(self, text: Option<impl Into<String>>) -> Self

Builder: set the inline after-comment.

pub fn set_before(&mut self, lines: impl IntoIterator<Item = impl Into<String>>)

In-place setter for before-lines.

pub fn set_after(&mut self, text: Option<impl Into<String>>)

In-place setter for the inline after-comment.

Trait Implementations

impl Clone for Comment

fn clone(&self) -> Comment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Comment

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

Formats the value using the given formatter.

impl Default for Comment

fn default() -> Comment

Returns the “default value” for a type.

impl PartialEq for Comment

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