Struct Comments 

pub struct Comments { /* private fields */ }

The comments a node owns (Document::comments), each list in source order.

A mapping entry is named by its key: its leading and trailing comments are read from the key’s handle (see NodeRef::key); a value written on the line below its key (k:⏎ # c⏎ v) has leading comments of its own.

Implementations

impl Comments

pub fn leading(&self) -> &[Comment]

The comment lines above the entry, item, or node (rules 3, 4, 9–13).

pub fn trailing(&self) -> &[Comment]

The same-line comments (rule 5): usually one, on the entry’s first line; an entry whose flow value spans lines can also have one after its closing bracket.

pub fn footer(&self) -> &[Comment]

The footer of a collection (rules 6 and 9): the comment lines after its last entry (block), or before its closing bracket (flow).

pub fn blank_lines_before(&self) -> usize

Blank lines right above the line where the entry, item, or node starts (rule 8; below its leading comments, if any); 0 when it does not start its line.

pub fn is_empty(&self) -> bool

true without comments.

Trait Implementations

impl Clone for Comments

fn clone(&self) -> Self

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 Eq for Comments

impl Hash for Comments

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Comments

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Comments