Struct Directory 

pub struct Directory { /* private fields */ }

A file source that reads files from a directory.

Will try to ignore files be default. See WalkBuilder for more information.

Implementations

impl Directory

pub fn new( path: impl AsRef<Path>, buf_size: usize, ) -> Result<Self, Box<dyn ErrorTrait>>

Creates a new directory file source.

Set buf_size to a reasonable value for your system. You most likely would want to set this to the same value as read_limit when building a Gengo instance with a Builder.

Trait Implementations

impl<'files> FileSource<'files> for Directory

type Entry = PathBuf

type Filepath = PathBuf

type Contents = Vec<u8>

type State = ()

Sometimes it’s necessary to share a state between iterations to reduce expensive commands.

type Iter = Iter

fn entries(&'files self) -> Result<Self::Iter, Box<dyn ErrorTrait>>

Returns an iterator over the entries use to get filenames and contents.

fn filepath( &'files self, entry: &Self::Entry, _state: &mut Self::State, ) -> Result<Self::Filepath, Box<dyn ErrorTrait>>

Gets a filename from an entry.

fn contents( &'files self, entry: &Self::Entry, _state: &mut Self::State, ) -> Result<Self::Contents, Box<dyn ErrorTrait>>

Gets file contents from an entry.

fn state(&'files self) -> Result<Self::State, Box<dyn ErrorTrait>>

Gets a state that can be shared between iterations.

fn overrides( &self, path: impl AsRef<Path>, state: &mut Self::State, ) -> Overrides

Provides combined overrides for the file.

fn language_override( &self, _path: impl AsRef<Path>, _state: &mut Self::State, ) -> Option<Language>

Provides an optional override for the detected language.

fn is_documentation_override( &self, _path: impl AsRef<Path>, _state: &mut Self::State, ) -> Option<bool>

Provides an optional override for documentation file detection.

fn is_generated_override( &self, _path: impl AsRef<Path>, _state: &mut Self::State, ) -> Option<bool>

Provides an optional override for generated file detection.

fn is_vendored_override( &self, _path: impl AsRef<Path>, _state: &mut Self::State, ) -> Option<bool>

Provides an optional override for vendored file detection.

fn is_detectable_override( &self, _path: impl AsRef<Path>, _state: &mut Self::State, ) -> Option<bool>

Provides an optional override for if the file is detectable.