Struct Parser

pub struct Parser { /* private fields */ }

Implementations

impl Parser

pub fn from_files<P: AsRef<Path>, Q: AsRef<Path>>( paths: impl Iterator<Item = P>, root_path: Q, ) -> Result<Self>

Builds a parser from the given set of files, as well as any files they depend on, recursively.

TODO(aksiksi): Respect .gitignore and .ignore files via [ignore].

pub fn from_directory<P: AsRef<Path>>(path: P, ignore: bool) -> Result<Self>

Recursively walks through all files in the given path and parses them.

If ignore is set, this method will respect .gitignore and .ignore files (via [ignore]).

pub fn on_change_blocks_in_file<P: AsRef<Path>>( &self, path: P, ) -> Option<impl Iterator<Item = &OnChangeBlock>>

Returns a iterator over all of the blocks in a specific file.

pub fn get_block_in_file<P: AsRef<Path>>( &self, path: P, block_name: &str, ) -> Option<&OnChangeBlock>

Returns a iterator over all of the blocks in a specific file.

pub fn paths(&self) -> impl Iterator<Item = &Path>

pub fn root_path(&self) -> &Path

pub fn num_blocks(&self) -> usize

impl Parser

pub fn from_git_repo<P: AsRef<Path>>(path: P) -> Result<Self>

Builds a parser from staged files in a Git repo.

pub fn validate_git_repo(&self) -> Result<Vec<OnChangeViolation<'_>>>

Trait Implementations

impl Debug for Parser

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

Formats the value using the given formatter.