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

SqlSource

sql_docs::source

Struct SqlSource 

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

Holds the optional path and content of the sql to be parsed

Implementations§

Source§

impl SqlSource

Source

pub fn from_path(path: &Path) -> Result<Self>

Loads a SqlSource from the given path.

§Errors
  • Returns an io::Error if the file cannot be read.
Source

pub const fn from_str(content: String, path: Option<PathBuf>) -> Self

Creates an SqlSource from a a String and a Option<PathBuf>

Source

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

Returns the filesystem path associated with this SQL file.

Source

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

Returns the PathBuf for the current path

Source

pub fn content(&self) -> &str

Returns the raw SQL text contained in this file.

Source

pub fn sql_sources(path: &Path, deny_list: &[String]) -> Result<Vec<Self>>

Recursively discovers .sql files under path, applies the optional deny list, and loads the contents of each file.

§Parameters
  • path: Root directory to scan recursively for .sql files.
  • deny_list: Optional list of path-like strings representing files
§Errors

Returns an io::Error if directory traversal fails or if any of the discovered SQL files cannot be read.

Trait Implementations§

Source§

impl Debug for SqlSource

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.