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

ParsedSqlFile

sql_docs::ast

Struct ParsedSqlFile 

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

A single SQL file plus all Statement.

Implementations§

Source§

impl ParsedSqlFile

Source

pub fn parse(file: SqlSource) -> Result<Self, ParserError>

Parses a SqlSource into sqlparser Statement nodes.

This is the AST layer used by the comments module to attach leading comment spans to statements/columns.

§Parameters
§Errors
Source

pub const fn file(&self) -> &SqlSource

Getter method for returning the SqlSource

Source

pub fn path(&self) -> Option<&Path>

Getter method for returning the current object’s file’s path

Source

pub fn path_into_path_buf(&self) -> Option<PathBuf>

Getter that returns an PathBuf for the path rather than &Path

Source

pub fn content(&self) -> &str

Getter for the file’s content

Source

pub fn statements(&self) -> &[Statement]

Getter method for returning the vector of all statements Statement

Trait Implementations§

Source§

impl Debug for ParsedSqlFile

Source§

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

Formats the value using the given formatter. Read more

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> 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, 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.