Struct Comments 

pub struct Comments(/* private fields */);

An opaque container for comments from a parse SQL source code.

Implementations

impl Comments

pub fn offer(&mut self, comment: CommentWithSpan)

Accepts comment if its the first or is located strictly after the last accepted comment. In other words, this method will skip the comment if its comming out of order (as encountered in the parsed source code.)

pub fn find<R: RangeBounds<Location>>(&self, range: R) -> Iter<'_>

Finds comments starting within the given location range. The order of iterator reflects the order of the comments as encountered in the parsed source code.

Example

use sqlparser::{dialect::GenericDialect, parser::Parser, tokenizer::Location};

let sql = r#"/*
 header comment ...
 ... spanning multiple lines
*/

 -- first statement
 SELECT 'hello' /* world */ FROM DUAL;

 -- second statement
 SELECT 123 FROM DUAL;

 -- trailing comment
"#;

let (ast, comments) = Parser::parse_sql_with_comments(&GenericDialect, sql).unwrap();

// all comments appearing before line seven, i.e. before the first statement itself
assert_eq!(
   &comments.find(..Location::new(7, 1)).map(|c| c.as_str()).collect::<Vec<_>>(),
   &["\n header comment ...\n ... spanning multiple lines\n", " first statement"]);

// all comments appearing within the first statement
assert_eq!(
   &comments.find(Location::new(7, 1)..Location::new(8,1)).map(|c| c.as_str()).collect::<Vec<_>>(),
   &[" world "]);

// all comments appearing within or after the first statement
assert_eq!(
   &comments.find(Location::new(7, 1)..).map(|c| c.as_str()).collect::<Vec<_>>(),
   &[" world ", " second statement", " trailing comment"]);

The Spanned trait allows you to access location information for certain AST nodes.

Trait Implementations

impl Clone for Comments

fn clone(&self) -> Comments

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Comments

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

Formats the value using the given formatter.

impl Default for Comments

fn default() -> Comments

Returns the “default value” for a type.

impl From<Comments> for Vec<CommentWithSpan>

fn from(comments: Comments) -> Self

Converts to this type from the input type.