Enum CommentSyntax 

#[repr(u8)]
pub enum CommentSyntax {
    Hash = 0,
    DoubleSlash = 1,
    Semicolon = 2,
    Xml = 3,
}

Comment delimiter for plain text formats that support comments.

Variants

Hash = 0

# comment.

DoubleSlash = 1

// comment.

Semicolon = 2

; comment.

Xml = 3

<!-- comment -->.

Implementations

impl CommentSyntax

pub(crate) const ALL: [Self; 4]

Every syntax.

pub(crate) fn uncomment(self, line: &str) -> Option<&str>

The text of line when it is a comment of one line in this syntax.

const fn line_delimiter(self) -> Option<&'static str>

The delimiter that starts each line, or None for the block syntax.

pub(crate) fn comment(self, comment: &str) -> impl Display + '_

Render a comment in this syntax. Every output line ends with \n.

Line syntaxes prefix every line. The block syntax wraps the whole text once.

pub(crate) fn write_lines( self, out: &mut impl Write, comment: &str, indent: impl Display, ) -> Result

Write the lines of a comment in this syntax, each after indent.

Trait Implementations

impl Clone for CommentSyntax

fn clone(&self) -> CommentSyntax

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CommentSyntax

impl Debug for CommentSyntax

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

Formats the value using the given formatter.

impl Eq for CommentSyntax

impl<'ʄ> Facet<'ʄ> for CommentSyntax

const SHAPE: &'static Shape

The shape of this type, including: whether it’s a Struct, an Enum, something else?

impl PartialEq for CommentSyntax

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CommentSyntax