[go: up one dir, main page]
Skip to main content

SqlFileDoc

sql_docs::docs

Struct SqlFileDoc 

Source 
pub struct SqlFileDoc { /* private fields */ }
Expand description

Structure for containing the docs for every Table in an .sql file as a Vec of TableDoc

Implementations§

Source§

impl SqlFileDoc

Source

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

Create a new instance of SqlFileDoc

§Parameters
  • tables the Vec of TableDoc for the struct
Source

pub fn from_parsed_file( file: &ParsedSqlFile, comments: &Comments, capture: LeadingCommentCapture, flatten: MultiFlatten<'_>, ) -> Result<Self, DocError>

Final structured documentation extracted from one SQL file.

This merges:

  • Parsed SQL AST (CREATE TABLE statements for example)
  • Comment spans into a format suitable for documentation generation.
§Parameters
§Errors
Source

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

Getter function to get a slice of TableDoc

Source

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

Getter that returns a mutable reference to the TableDoc vec

Source

pub fn number_of_tables(&self) -> usize

Returns the number fo tables in the SqlFileDoc

Trait Implementations§

Source§

impl Clone for SqlFileDoc

Source§

fn clone(&self) -> SqlFileDoc

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SqlFileDoc

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<SqlFileDoc> for Vec<TableDoc>

Converts a file doc into its table docs (consumes the SqlFileDoc).

Source§

fn from(value: SqlFileDoc) -> Self

Converts to this type from the input type.
Source§

impl IntoIterator for SqlFileDoc

Source§

type Item = TableDoc

The type of the elements being iterated over.
Source§

type IntoIter = <Vec<TableDoc> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl PartialEq for SqlFileDoc

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for SqlFileDoc

Source§

impl StructuralPartialEq for SqlFileDoc

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.