Struct SqlDocBuilder 

pub struct SqlDocBuilder<'a> { /* private fields */ }

Builder structure for the SqlDoc

Implementations

impl<'a> SqlDocBuilder<'a>

pub fn deny(self, deny_path: &str) -> Self

Method for adding an item to the deny list

Parameters

• The path that will be added to deny path Vec

pub const fn flatten_multiline(self) -> Self

Flattens the multiline comments without additional formatting

pub const fn flatten_multiline_with(self, suffix: &'a str) -> Self

Flattens the multiline comments with String containing additional leading line formatting to add, such as punctuation.

pub const fn preserve_multiline(self) -> Self

Preserves multiline comments line structure

pub const fn collect_single_nearest(self) -> Self

Collects only the comment on preceding lines

pub const fn collect_all_leading(self) -> Self

Collects All valid comments on preceding lines

pub const fn collect_all_single_one_multi(self) -> Self

Collects all single line comments and at most one multiline comment

pub fn build(self) -> Result<SqlDoc, DocError>

Builds the SqlDoc

Comment flattening (if enabled) is applied as a post-processing step after docs are generated.

Errors

• Will return DocError bubbled up

Trait Implementations

impl<'a> Debug for SqlDocBuilder<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for SqlDocBuilder<'a>

fn eq(&self, other: &SqlDocBuilder<'a>) -> 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<'a> Eq for SqlDocBuilder<'a>

impl<'a> StructuralPartialEq for SqlDocBuilder<'a>