Struct CurrentWorkingDirectory 

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

The working directory in which a command was called

The current working directory is the directory from which Clawless commands are run. It is passed to commands via the Context struct, allowing commands to operate relative to this directory.

Please note that the path is not updated if commands manually change into another directory.

Implementations

impl CurrentWorkingDirectory

pub fn new(path: PathBuf) -> Self

Create a new #ident

This method creates a new #ident 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

Get the inner value of the #ident

This method returns a reference to the inner value of the #ident.

impl CurrentWorkingDirectory

pub fn try_from_env() -> Result<CurrentWorkingDirectory, ContextError>

Creates a CurrentWorkingDirectory from the environment

This function retrieves the current working directory from the environment and creates a CurrentWorkingDirectory instance. If the current directory cannot be determined, an error is returned.

Errors

Returns std::io::Error if the current directory cannot be determined from the environment.

Trait Implementations

impl Clone for CurrentWorkingDirectory

fn clone(&self) -> CurrentWorkingDirectory

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CurrentWorkingDirectory

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

Formats the value using the given formatter.

impl Display for CurrentWorkingDirectory

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

Formats the value using the given formatter.

impl Eq for CurrentWorkingDirectory

impl From<&Path> for CurrentWorkingDirectory

fn from(path: &Path) -> CurrentWorkingDirectory

Converts to this type from the input type.

impl From<&str> for CurrentWorkingDirectory

fn from(string: &str) -> CurrentWorkingDirectory

Converts to this type from the input type.

impl From<String> for CurrentWorkingDirectory

fn from(string: String) -> CurrentWorkingDirectory

Converts to this type from the input type.

impl Hash for CurrentWorkingDirectory

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

fn cmp(&self, other: &CurrentWorkingDirectory) -> 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.

impl PartialEq for CurrentWorkingDirectory

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for CurrentWorkingDirectory

fn partial_cmp(&self, other: &CurrentWorkingDirectory) -> 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 CurrentWorkingDirectory