Struct ElementComment 

#[non_exhaustive]
pub struct ElementComment {
    pub array: Vec<PathSegment>,
    pub index: usize,
    pub after_spread: bool,
    pub value: Option<String>,
    pub text: String,
    pub heading: bool,
}

The comment written next to one element of an array literal: on the lines directly above it, or after it on the line where it ends.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

array: Vec<PathSegment>

The path to the array from the outermost literal that contains it.

index: usize

The position of the element in the array literal; a spread counts as one element.

after_spread: bool

Whether the element is a spread or comes after one. An evaluator that expands spreads puts such an element at a position that index does not give, so pairing by position is only sound when this is false.

value: Option<String>

The element when it is a string (its value) or a regular expression literal (its pattern).

text: String

The comment text without its delimiters, its lines joined by single spaces. Comments both above and after the element are joined in source order.

heading: bool

The element has no comment of its own and text is its group heading: the comments above the nearest element before it in the same array that has comments above it. A list written as groups, each under one comment line, explains every element of a group with that line.

Implementations

impl ElementComment

pub fn new( array: Vec<PathSegment>, index: usize, value: Option<String>, text: impl Into<String>, ) -> Self

The comment text on the element index of the array at array, whose value is value.

pub fn after_spread(self) -> Self

This comment, recording that its element is a spread or comes after one.

pub fn under_heading(self) -> Self

This comment, recording that it is the group heading of its element rather than a comment of its own.

Trait Implementations

impl Clone for ElementComment

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 ElementComment

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

Formats the value using the given formatter.

impl Eq for ElementComment

impl PartialEq for ElementComment

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ElementComment