Struct sqruff_lib::core::templaters::base::TemplatedFile

pub struct TemplatedFile {
    pub source_str: String,
    pub templated_str: Option<String>,
    pub sliced_file: Vec<TemplatedFileSlice>,
    /* private fields */
}

A templated SQL file.

This is the response of a templater’s .process() method and contains both references to the original file and also the capability to split up that file when lexing.

Fields

source_str: String

templated_str: Option<String>

sliced_file: Vec<TemplatedFileSlice>

Implementations

impl TemplatedFile

pub fn new( source_str: String, f_name: String, input_templated_str: Option<String>, sliced_file: Option<Vec<TemplatedFileSlice>>, input_raw_sliced: Option<Vec<RawFileSlice>> ) -> Result<TemplatedFile, SQLFluffSkipFile>

Initialise the TemplatedFile. If no templated_str is provided then we assume that the file is NOT templated and that the templated view is the same as the source view.

pub fn is_templated(&self) -> bool

Return true if there’s a templated file.

pub fn get_line_pos_of_char_pos( &self, char_pos: usize, source: bool ) -> (usize, usize)

Get the line number and position of a point in the source file. Args:

• char_pos: The character position in the relevant file.
• source: Are we checking the source file (as opposed to the templated file)

Returns: line_number, line_position

pub fn from_string(raw: String) -> TemplatedFile

Create TemplatedFile from a string.

pub fn get_templated_string(&self) -> Option<&str>

Get templated string

pub fn to_string(&self) -> String

Return the templated file if coerced to string.

pub fn source_only_slices(&self) -> Vec<RawFileSlice>

Return a list a slices which reference the parts only in the source.

All of these slices should be expected to have zero-length in the templated file.

    The results are NECESSARILY sorted.

pub fn find_slice_indices_of_templated_pos( &self, templated_pos: usize, start_idx: Option<usize>, inclusive: Option<bool> ) -> Result<(usize, usize), ValueError>

Find a subset of the sliced file which touch this point.

The last_idx is exclusive, as the intent is to use this as a slice.

pub fn templated_slice_to_source_slice( &self, template_slice: Range<usize> ) -> Result<Range<usize>, ValueError>

Convert a template slice to a source slice.

pub fn is_source_slice_literal(&self, source_slice: &Range<usize>) -> bool

Work out whether a slice of the source file is a literal or not.

Trait Implementations

impl Clone for TemplatedFile

fn clone(&self) -> TemplatedFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TemplatedFile

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

Formats the value using the given formatter.

impl Hash for TemplatedFile

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for TemplatedFile

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for TemplatedFile

impl StructuralPartialEq for TemplatedFile