Struct substrait_validator::output::comment::Comment

pub struct Comment { /* private fields */ }

Representation of a comment message intended only for human consumption. Includes basic formatting information.

Implementations

impl Comment

pub fn new() -> Self

Creates an empty comment.

pub fn plain<S: ToString>(self, text: S) -> Self

Adds a piece of plain text to the comment.

pub fn link<S: ToString>(self, text: S, path: PathBuf) -> Self

Adds a piece of text to the comment that links to the given path.

pub fn url<S: ToString, U: ToString>(self, text: S, url: U) -> Self

Adds a piece of text to the comment that links to the given URL.

pub fn nl(self) -> Self

Adds a newline/paragraph break.

pub fn lo(self) -> Self

Opens a list.

pub fn li(self) -> Self

Advances to the next list item.

pub fn lc(self) -> Self

Closes the current list.

pub fn push(&mut self, element: Element)

Pushes an element into this comment.

pub fn extend(&mut self, other: Comment)

Pushes a whole other comment’s worth of elements into this comment.

pub fn elements(&self) -> &[Element]

Returns the slice of elements that comprise the comment.

This list is “minimal:”

• there are no consecutive newlines, list item tags, or spans with equal formatting (they are merged together);
• there are no empty lists, and there is never a list item immediately following a list open tag (as this is redundant).

Trait Implementations

impl Clone for Comment

fn clone(&self) -> Comment

Returns a copy of the value.

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.

impl Default for Comment

fn default() -> Comment

Returns the “default value” for a type.

impl Display for Comment

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

Formats the value using the given formatter.

impl From<&'_ Comment> for Comment

fn from(node: &Comment) -> Self

Converts to this type from the input type.

impl From<Brief> for Comment

fn from(brief: Brief) -> Self

Converts to this type from the input type.

impl From<String> for Comment

fn from(text: String) -> Self

Converts to this type from the input type.

impl PartialEq<Comment> for Comment

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Comment