pub struct SearchPaths { /* private fields */ }Expand description
Passed to preprocess or preprocess_with_source_tracker to configure file resolution.
For details on file resolution, see the File Resolution section of the top-level documentation.
Implementations§
Source§impl SearchPaths
impl SearchPaths
Sourcepub fn new() -> Self
pub fn new() -> Self
Creates a new empty SearchPaths instance that does not yet contain any search-paths.
Sourcepub fn push_base_path<P>(&mut self, path: P)
pub fn push_base_path<P>(&mut self, path: P)
Adds a new “base path” to the search paths.
Refer to the File Resolution section of the top-level documentation for details on how base paths are used to resolve included file paths.
Sourcepub fn push_quoted_path<P>(&mut self, path: P)
pub fn push_quoted_path<P>(&mut self, path: P)
Adds a new “quoted path” to the search paths.
Refer to the File Resolution section of the top-level documentation for details on how quoted paths are used to resolve included file paths.
Sourcepub fn base_paths(&self) -> impl Iterator<Item = &PathBuf>
pub fn base_paths(&self) -> impl Iterator<Item = &PathBuf>
Returns in iterator over the “base paths” registered with this SearchPaths instance, in the order in which they were added.
Refer to the File Resolution section of the top-level documentation for details on how base paths are used to resolve included file paths.
Sourcepub fn quoted_paths(&self) -> impl Iterator<Item = &PathBuf>
pub fn quoted_paths(&self) -> impl Iterator<Item = &PathBuf>
Returns in iterator over the “quoted paths” registered with this SearchPaths instance, in the order in which they were added.
Refer to the File Resolution section of the top-level documentation for details on how quoted paths are used to resolve included file paths.