Struct WithLocal 

pub struct WithLocal { /* private fields */ }

Stores both the normal and local form a configuration path.

The local form has .local inserted just before the extension: cli-app.kdl has the local form cli-app.local.kdl.

While this is mostly intended for file, nothing precludes an application from using it for directories.

use std::path::{Path, PathBuf};

use config_finder::WithLocal;

// `.local` is inserted before the extension for the `.local_path()` form
let wl = WithLocal::new("cli-app", "kdl");
assert_eq!(wl.path(), Path::new("cli-app.kdl"));
assert_eq!(wl.local_path(), Path::new("cli-app.local.kdl"));

// Even if the extension is empty (can notably be used for directories)
let wl = WithLocal::new("cli-app", "");
assert_eq!(wl.path(), Path::new("cli-app"));
assert_eq!(wl.local_path(), Path::new("cli-app.local"));

// An empty base is valid too
let wl = WithLocal::new("", "kdl");
assert_eq!(wl.path(), Path::new(".kdl"));
assert_eq!(wl.local_path(), Path::new(".local.kdl"));

// If you need to store a form (local or not),
let wl = WithLocal::new("zellij", "kdl");
assert_eq!(wl.into_paths(), (PathBuf::from("zellij.kdl"), PathBuf::from("zellij.local.kdl")));

Implementations

impl WithLocal

pub fn new(base: impl Into<OsString>, ext: impl AsRef<OsStr>) -> Self

Computes both the normal and local forms of the path.

If the extension is non-empty, inserts a dot (.) between the base and the extension.

pub fn path(&self) -> &Path

Path without the added .local just before the extension.

pub fn local_path(&self) -> &Path

Path with the added .local just before the extension.

pub fn into_paths(self) -> (PathBuf, PathBuf)

Destructure into the inner (path, local_path) without allocating.

Trait Implementations

impl Clone for WithLocal

fn clone(&self) -> WithLocal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WithLocal

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

Formats the value using the given formatter.

impl Hash for WithLocal

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 WithLocal

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for WithLocal

impl StructuralPartialEq for WithLocal