Enum json5format::Comment

pub enum Comment {
    Block {
        lines: Vec<String>,
        align: bool,
    },
    Line(String),
    Break,
}

Represents the variations of allowable comments.

Variants

Block

Represents a comment read from a /* */ pattern.

Fields of Block

lines: Vec<String>

The content of the block comment, represented as a String for each line.

align: bool

align (if true) indicates that all comment lines started in a column after the star’s column in the opening /*. For each subsequent line in lines, the spaces from column 0 to the star’s column will be stripped, allowing the indent spaces to be restored, during format, relative to the block’s new horizontal position. Otherwise, the original indentation will not be stripped, and the lines will be restored at their original horizontal position. In either case, lines after the opening /* will retain their original horizontal alignment, relative to one another.

Line(String)

Represents a comment read from a line starting with //.

Break

Represents a blank line between data.

Implementations

impl Comment

pub fn is_block(&self) -> bool

Returns true if the Comment instance is a Block variant.

pub fn is_line(&self) -> bool

Returns true if the Comment instance is a Line variant.

pub fn is_break(&self) -> bool

Returns true if the Comment instance is a Break variant.

Trait Implementations

impl Clone for Comment

fn clone(&self) -> Comment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Comment

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

Formats the value using the given formatter.