Struct Comment 

pub struct Comment<'input> { /* private fields */ }

YAML comment metadata captured from the source.

Comments are presentation metadata, not YAML data. This type carries the raw comment payload and a best-effort Placement hint. The companion Token carries the comment’s source span.

Implementations

impl<'input> Comment<'input>

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

Create captured YAML comment metadata from a 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 text(&self) -> &str

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

pub const fn placement(&self) -> Placement

Return the best-effort placement of this comment relative to nearby YAML content.

pub fn into_text(self) -> Cow<'input, str>

Consume the comment and return its raw payload without cloning.

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> Eq for Comment<'input>

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

fn eq(&self, other: &Comment<'input>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

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