Enum json5format::Comment

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

Represents the variations of allowable comments.

Variants§

§

Block

Fields

§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.

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

§

Line(String)

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

§

Break

Represents a blank line between data.

Implementations§

source§

impl Comment

source

pub fn is_block(&self) -> bool

Returns true if the Comment instance is a Block variant.

source

pub fn is_line(&self) -> bool

Returns true if the Comment instance is a Line variant.

source

pub fn is_break(&self) -> bool

Returns true if the Comment instance is a Break variant.

Trait Implementations§

source§

impl Clone for Comment

source§

fn clone(&self) -> Comment

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Comment

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.