Enum CommentLinePosition 

pub enum CommentLinePosition {
    EndOfLine,
    OwnLine,
}

The position of a comment in the source text.

Variants

EndOfLine

A comment that is on the same line as the preceding token and is separated by at least one line break from the following token.

Examples

End of line

a; # comment
b;

# comment is an end of line comments because it is separated by at least one line break from the following token b. Comments that not only end, but also start on a new line are OwnLine comments.

OwnLine

A Comment that is separated by at least one line break from the preceding token.

Examples

a;
# comment
b;

# comment line comments because they are separated by one line break from the preceding token a.

Implementations

impl CommentLinePosition

pub const fn is_own_line(self) -> bool

pub const fn is_end_of_line(self) -> bool

pub fn for_range(comment_range: TextRange, source_code: &str) -> Self

Finds the line position of a comment given a range over a valid comment.

Trait Implementations

impl Clone for CommentLinePosition

fn clone(&self) -> CommentLinePosition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommentLinePosition

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

Formats the value using the given formatter.

impl PartialEq for CommentLinePosition

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for CommentLinePosition

impl Eq for CommentLinePosition

impl StructuralPartialEq for CommentLinePosition