Struct FileFinder 

pub struct FileFinder { /* private fields */ }

👎Deprecated since 2.0.1: use cfgmatic-source crate instead, which provides a unified configuration source API

Builder for configuring file search.

Example

use cfgmatic_files::FileFinder;

let finder = FileFinder::new("myapp")
    .formats(&[cfgmatic_files::Format::Toml, cfgmatic_files::Format::Json])
    .base_name("config")
    .require_existence(true);

Implementations

impl FileFinder

pub fn new(app_name: impl Into<String>) -> Self

👎Deprecated since 2.0.1: use cfgmatic-source crate instead, which provides a unified configuration source API

Create a new file finder for the given application.

pub fn formats(self, formats: &[Format]) -> Self

👎Deprecated since 2.0.1: use cfgmatic-source crate instead, which provides a unified configuration source API

Set the file formats to search for.

pub fn base_name(self, name: impl Into<String>) -> Self

👎Deprecated since 2.0.1: use cfgmatic-source crate instead, which provides a unified configuration source API

Set the base name for config files.

For example, if base_name is “app”, files like “app.toml”, “app.json” will be searched.

pub fn any_name(self) -> Self

👎Deprecated since 2.0.1: use cfgmatic-source crate instead, which provides a unified configuration source API

Clear the base name, searching for any file with supported extensions.

pub const fn require_existence(self, require: bool) -> Self

👎Deprecated since 2.0.1: use cfgmatic-source crate instead, which provides a unified configuration source API

Require that files exist (default: true).

pub const fn follow_symlinks(self, follow: bool) -> Self

👎Deprecated since 2.0.1: use cfgmatic-source crate instead, which provides a unified configuration source API

Follow symbolic links when searching.

pub const fn search_depth(self, depth: usize) -> Self

👎Deprecated since 2.0.1: use cfgmatic-source crate instead, which provides a unified configuration source API

Set the maximum search depth for directory traversal.

pub fn build(self) -> FileFinderState

👎Deprecated since 2.0.1: use cfgmatic-source crate instead, which provides a unified configuration source API

Build the finder configuration.

pub fn find(self) -> Result<ConfigFiles>

👎Deprecated since 2.0.1: use cfgmatic-source crate instead, which provides a unified configuration source API

Find all matching configuration files.

This is a convenience method that builds and searches immediately.

Errors

Returns an error if directories cannot be accessed.

pub fn find_first(self) -> Result<Option<ConfigFile>>

👎Deprecated since 2.0.1: use cfgmatic-source crate instead, which provides a unified configuration source API

Find the first (highest priority) configuration file.

Errors

Returns an error if directories cannot be accessed.

Trait Implementations

impl Clone for FileFinder

fn clone(&self) -> FileFinder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileFinder

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

Formats the value using the given formatter.