Struct GenPath 

pub struct GenPath;

Helper for building paths from the current process location.

Implementations

impl GenPath

pub fn from_working_dir(steps: i32) -> Result<PathBuf, DatabaseError>

Returns the working directory, with steps parts removed from the end.

Parameters

• steps: number of path parts at the end to remove.

Errors

Returns an error if:

• the current directory cannot be read,
• steps is greater than or equal to the number of removable segments.

Examples

use file_database::{DatabaseError, GenPath};

fn main() -> Result<(), DatabaseError> {
    let _cwd = GenPath::from_working_dir(0)?;
    Ok(())
}

pub fn from_exe(steps: i32) -> Result<PathBuf, DatabaseError>

Returns the executable directory, with steps parts removed from the end.

Parameters

• steps: number of path parts at the end to remove from the executable directory.

Errors

Returns an error if:

• the executable path cannot be read,
• steps is too large for the path depth.

Examples

use file_database::{DatabaseError, GenPath};

fn main() -> Result<(), DatabaseError> {
    let _exe_dir = GenPath::from_exe(0)?;
    Ok(())
}

pub fn from_closest_match( name: impl AsRef<Path>, ) -> Result<PathBuf, DatabaseError>

Looks for the nearest matching folder name while walking up from the executable.

At each level, this checks:

• the folder name itself,
• child folders one level down.

File entries are ignored.

Parameters

• name: directory name to search for.

Errors

Returns an error if:

• no matching directory is found,
• the provided name cannot be converted from OsStr to String.

Examples

use file_database::{DatabaseError, GenPath};

fn main() -> Result<(), DatabaseError> {
    let _path = GenPath::from_closest_match("src")?;
    Ok(())
}

Trait Implementations

impl Clone for GenPath

fn clone(&self) -> GenPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GenPath

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

Formats the value using the given formatter.

impl Default for GenPath

fn default() -> GenPath

Returns the “default value” for a type.

impl PartialEq for GenPath

fn eq(&self, other: &GenPath) -> 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 StructuralPartialEq for GenPath