Struct Comment 

pub struct Comment { /* private fields */ }

A comment rule.

Comments do not generate tokens, unlike most rules. Instead, they are attached to the span of a token, and can be inspected through Span::comments().

Implementations

impl Comment

pub fn line(delim: impl Into<Yarn>) -> Self

Creates a new line comment. Line comments cannot nest, and run from starting delimiter (which is something like // or #) to the next '\n' character (not including it).

pub fn block(open: impl Into<Yarn>, close: impl Into<Yarn>) -> Self

Creates a new nestable block comment with paired delimiters.

pub fn nesting(bracket: Bracket) -> Self

Creates a new comment that can nest. For example, Rust block comments can nest: /* /* */ */

pub fn non_nesting(bracket: Bracket) -> Self

Creates a new comment that can’t nest. For example, a line comment is a non-nesting comment where a newline ‘\n’ is the closing delimiter.

Trait Implementations

impl Debug for Comment

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

Formats the value using the given formatter.

impl From<&'static str> for Comment

fn from(value: &'static str) -> Self

Converts to this type from the input type.

impl<Y: Into<Yarn>, Z: Into<Yarn>> From<(Y, Z)> for Comment

fn from((y, z): (Y, Z)) -> Self

Converts to this type from the input type.

impl From<Comment> for Any

fn from(value: Comment) -> Self

Converts to this type from the input type.

impl From<YarnBox<'static, str>> for Comment

fn from(value: Yarn) -> Self

Converts to this type from the input type.

impl From<char> for Comment

fn from(value: char) -> Self

Converts to this type from the input type.

impl Rule for Comment

type Token<'lex> = Never

This rule’s corresponding token type.

fn try_from_ref(value: &Any) -> Result<&Self, WrongKind>

Converts a reference to Any to a reference to this kind of rule.

impl TryFrom<Any> for Comment

type Error = WrongKind

The type returned in the event of a conversion error.

fn try_from(value: Any) -> Result<Self, Self::Error>

Performs the conversion.