Struct Comment 

pub struct Comment<'input> {
    pub span: Span,
    pub text: Cow<'input, str>,
    pub placement: Placement,
}

A YAML comment captured from the source.

Comments are presentation metadata, not YAML data. This type carries the raw comment payload, source span, and a best-effort Placement hint for callers that want to correlate comments with nearby YAML presentation.

Fields

span: Span

Span covering the whole source comment, including # and excluding the line break.

text: Cow<'input, str>

Raw comment payload exactly after #, excluding only the line break.

Leading spaces are preserved, including a single space immediately after # when present.

placement: Placement

Best-effort placement of this comment relative to nearby YAML content.

Implementations

impl<'input> Comment<'input>

pub fn new(span: Span, text: impl Into<Cow<'input, str>>) -> Self

Create a captured YAML comment from a source span and raw payload.

The placement defaults to Placement::Free. Use Comment::with_placement when the caller already knows a more specific placement.

pub fn with_placement(self, placement: Placement) -> Self

Return this comment with the given placement.

pub fn trimmed_text(&self) -> &str

Return the comment payload with surrounding whitespace removed.

This helper is ergonomic only. The raw Self::text payload remains unchanged.

Trait Implementations

impl AsRef<str> for Comment<'_>

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl<'input> Clone for Comment<'input>

fn clone(&self) -> Comment<'input>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'input> Debug for Comment<'input>

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

Formats the value using the given formatter.

impl<'input> PartialEq for Comment<'input>

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

impl<'input> StructuralPartialEq for Comment<'input>