Struct WorkingDirectory 

pub struct WorkingDirectory(/* private fields */);

The directory in which an external command runs

Some commands work on the directory that they run in. A build tool reads the manifest of the project in that directory, and a formatter reads the configuration file that it finds there. Such a command carries the directory that it needs.

A command without a working directory runs where the process runs. Most commands need no directory of their own, which is why an invocation does not require one.

Implementations

impl WorkingDirectory

pub fn new(path: PathBuf) -> WorkingDirectory

Creates a new WorkingDirectory

This method creates a new WorkingDirectory from a PathBuf.

Example

use std::path::PathBuf;
use typed_fields::path;

path!(MyPath);

let path = MyPath::new(PathBuf::from("src"));

pub fn get(&self) -> &Path

Gets the inner value of the WorkingDirectory

This method returns a reference to the inner value of the WorkingDirectory.

Trait Implementations

impl Clone for WorkingDirectory

fn clone(&self) -> WorkingDirectory

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkingDirectory

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

Formats the value using the given formatter.

impl Display for WorkingDirectory

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

Formats the value using the given formatter.

impl Eq for WorkingDirectory

impl From<&Path> for WorkingDirectory

fn from(path: &Path) -> WorkingDirectory

Converts to this type from the input type.

impl From<&str> for WorkingDirectory

fn from(string: &str) -> WorkingDirectory

Converts to this type from the input type.

impl From<PathBuf> for WorkingDirectory

Creates a working directory from a path that the application built at runtime

fn from(path: PathBuf) -> WorkingDirectory

Converts to this type from the input type.

impl From<String> for WorkingDirectory

fn from(string: String) -> WorkingDirectory

Converts to this type from the input type.

impl Hash for WorkingDirectory

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 Ord for WorkingDirectory

fn cmp(&self, other: &WorkingDirectory) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for WorkingDirectory

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for WorkingDirectory

fn partial_cmp(&self, other: &WorkingDirectory) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for WorkingDirectory