Struct SqlDoc 

pub struct SqlDoc { /* private fields */ }

Top-level documentation object containing all discovered TableDoc entries.

Implementations

impl SqlDoc

pub fn new(tables: Vec<TableDoc>) -> Self

Method for creating a new SqlDoc

pub fn from_dir<P: AsRef<Path>>(root: &P) -> SqlDocBuilder<'_>

Method for generating builder from a directory.

pub fn from_path<P: AsRef<Path> + ?Sized>(path: &P) -> SqlDocBuilder<'_>

Method for generating builder from a Path of a single file

pub fn from_paths<P: AsRef<Path>>(paths: &[P]) -> SqlDocBuilder<'_>

Method for generating builder from a [[Path]]

pub const fn builder_from_str(content: &str) -> SqlDocBuilder<'_>

Creates a builder from SQL text (no filesystem path is associated) from a str

pub const fn builder_from_strs_with_paths( string_with_path: &[(String, PathBuf)], ) -> SqlDocBuilder<'_>

Creates a builder from a vec of tuples containing the sql as String and the path as PathBuf

pub fn table( &self, name: &str, schema: Option<&str>, ) -> Result<&TableDoc, DocError>

Method for finding a specific TableDoc by name

Parameters

• the table name as a str
• the table schema as Option of str

Errors

• Will return DocError::TableNotFound if the expected table is not found
• Will return DocError::TableWithSchemaNotFound if the table name exists but no table matches the given schema
• Will return DocError::DuplicateTablesFound if more than one matching table is found

pub fn tables(&self) -> &[TableDoc]

Getter method for returning the &[TableDoc]

pub fn tables_mut(&mut self) -> &mut [TableDoc]

Getter that returns a mutable reference to the TableDoc

pub fn into_tables(self) -> Vec<TableDoc>

Method to move tables out of Structure if needed

pub fn number_of_tables(&self) -> usize

Returns the number of TableDoc

Trait Implementations

impl Clone for SqlDoc

fn clone(&self) -> SqlDoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SqlDoc

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

Formats the value using the given formatter.

impl FromStr for SqlDoc

type Err = DocError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for SqlDoc

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

impl StructuralPartialEq for SqlDoc