Struct PropertyComment 

#[non_exhaustive]
pub struct PropertyComment {
    pub path: Vec<PathSegment>,
    pub text: String,
}

The comment written next to a property of an object literal: on the lines directly above it, after it on the line where it ends, or, when its value is an array literal, after the opening bracket on the bracket’s line.

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.

path: Vec<PathSegment>

The path from the outermost literal to the property’s value; its last segment is the property’s key.

text: String

The comment text without its delimiters, its lines joined by single spaces, joined in source order.

Implementations

impl PropertyComment

pub fn new(path: Vec<PathSegment>, text: impl Into<String>) -> Self

The comment text on the property at path.

Trait Implementations

impl Clone for PropertyComment

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 PropertyComment

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

Formats the value using the given formatter.

impl Eq for PropertyComment

impl PartialEq for PropertyComment

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PropertyComment