Struct envpath::EnvPath

pub struct EnvPath<'r> {
    pub path: Option<PathBuf>,
    /* private fields */
}

Fields

path: Option<PathBuf>

Implementations

impl<'r> EnvPath<'r>

pub fn new<V>(iter: V) -> Selfwhere V: IntoIterator<Item = &'r str>,

Create a new instance of EnvPath from an iterator over borrowed strings.

The function takes an iterator over borrowed strings and creates an instance of EnvPath. The raw value is automatically converted to represent the path structure.

If you only need to serialize the path to a configuration and do not require deserialization support, consider using the from() method instead of this constructor.

Examples

use envpath::EnvPath;

let path = EnvPath::new([
    "$env: home",
    ".local",
    "share",
    "$const: pkg",
    "$const: ver"
]);

dbg!(path.display(), path.exists());

pub fn new_owned<V, S>(iter: V) -> Selfwhere V: IntoIterator<Item = S>, S: Into<String>,

Create a new instance of EnvPath from an iterator over owned strings.

Note: new_owned() will convert &str to String, which may result in additional heap memory allocation.

To avoid additional heap memory allocation, you can use new() instead of new_owned().

The function takes an iterator over owned strings and creates an instance of EnvPath. The raw value is automatically converted to represent the path structure.

Examples

use envpath::EnvPath;

let arr = [
    "$env: home",
    ".local",
    "share",
    "$const: pkg",
    "$const: ver",
];

let path = EnvPath::new_owned(arr);

dbg!(path.display(), path.exists());

pub fn new_cow<V>(iter: V) -> Selfwhere V: IntoIterator<Item = Cow<'r, str>>,

Create a new instance of EnvPath from an iterator over borrowed Cow strings.

The function takes an iterator over borrowed Cow strings and creates an instance of EnvPath. The raw value is automatically converted to represent the path structure.

Examples

use std::borrow::Cow;
use envpath::EnvPath;

let arr = [
    "$env: home",
    ".local",
    "share",
    "$const: pkg",
    "$const: ver",
];

let path = EnvPath::new_cow(arr.map(Cow::Borrowed));
dbg!(path.display(), path.exists());

impl EnvPath<'_>

pub fn de(self) -> Self

This function is used for deserialization. Although EnvPath implements Deserialize Trait with deserialize(), it essentially calls this de() function.

In addition to deserializing the configuration file, you can parse the vector or array.

Examples

use envpath::EnvPath;

let path = EnvPath::from(["$dir: data ?? cfg", "$const: deb-arch"]).de();
dbg!(path.display(), path.exists());

impl<'r> EnvPath<'r>

pub fn get_raw(&self) -> &EnvPathRaw<'_>

Get a reference to the raw sequence of strings.

Examples

use envpath::EnvPath;

let path = EnvPath::from(["$env: home ?? userprofile", "3D Print"]);
dbg!(path.get_raw());

pub fn get_raw_mut(&mut self) -> &mut EnvPathRaw<'r>

get_raw_mut is a public method of the EnvPath struct that returns a mutable reference to the raw sequence of strings.

This method can be used to modify the raw sequence and update the EnvPath object accordingly. It takes no arguments and returns a mutable reference to an EnvPathRaw object.

pub fn set_raw<V: IntoIterator<Item = &'r str>>(&mut self, raw: V)

Set the raw sequence of strings.

Examples

use envpath::EnvPath;

let mut path = EnvPath::from(["$dir: cfg", "config.ron"]);
dbg!(path.get_raw());

path.set_raw(vec!["$project( com. x. y ): cfg", "config.toml"]);
dbg!(path.get_raw());

path.set_raw([" $dir:  bin ?? first-path  "]);
dbg!(path.de().display());

pub fn clear_raw(&mut self)

Clear the raw sequence of strings.

Examples

use envpath::EnvPath;

let mut path =
EnvPath::from(["$env: xdg_data_home", "$const: pkg", "files"]);

path.clear_raw();

assert!(path.get_raw().is_empty());

impl EnvPath<'_>

Implement additional methods for EnvPath when the project feature is enabled

If you see a method(function) with a parameter name containing _ prefix (e.g. _name) in some methods, do not delete it. This may be a platform-specific parameter, so to avoid the “unused variable” warning, I’ve added the “_” prefix.

pub fn new_project<Q, O, A>(qual: Q, org: O, app: A) -> Result<ProjectDirs>where Q: AsRef<str>, O: AsRef<str>, A: AsRef<str>,

The function returns an io::Result<ProjectDirs>, which is created using the ProjectDirs::from() method.

Note: directories::ProjectDirs is different from $proj of EnvPath!

Parameter	Description
qual	The qualifier of the project, which is a string reference.
org	The organization responsible for the project, also as a string reference.
app	The name of the application associated with the project, again as a string reference.

Here’s a table explaining the parts of the string “org.moz.ff” and what they represent:

Part	Abbreviation	Meaning
org	qual	qualifier
moz	org	organization
ff	app	application

Methods from Deref<Target = Path>

pub fn as_os_str(&self) -> &OsStr

Yields the underlying OsStr slice.

Examples

use std::path::Path;

let os_str = Path::new("foo.txt").as_os_str();
assert_eq!(os_str, std::ffi::OsStr::new("foo.txt"));

pub fn as_mut_os_str(&mut self) -> &mut OsStr

Yields a mutable reference to the underlying OsStr slice.

Examples

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

let mut path = PathBuf::from("Foo.TXT");

assert_ne!(path, Path::new("foo.txt"));

path.as_mut_os_str().make_ascii_lowercase();
assert_eq!(path, Path::new("foo.txt"));

pub fn to_str(&self) -> Option<&str>

Yields a &str slice if the Path is valid unicode.

This conversion may entail doing a check for UTF-8 validity. Note that validation is performed because non-UTF-8 strings are perfectly valid for some OS.

Examples

use std::path::Path;

let path = Path::new("foo.txt");
assert_eq!(path.to_str(), Some("foo.txt"));

pub fn to_string_lossy(&self) -> Cow<'_, str>

Converts a Path to a Cow<str>.

Any non-Unicode sequences are replaced with U+FFFD REPLACEMENT CHARACTER.

Examples

Calling to_string_lossy on a Path with valid unicode:

use std::path::Path;

let path = Path::new("foo.txt");
assert_eq!(path.to_string_lossy(), "foo.txt");

Had path contained invalid unicode, the to_string_lossy call might have returned "fo�.txt".

pub fn to_path_buf(&self) -> PathBuf

Converts a Path to an owned PathBuf.

Examples

use std::path::Path;

let path_buf = Path::new("foo.txt").to_path_buf();
assert_eq!(path_buf, std::path::PathBuf::from("foo.txt"));

pub fn is_absolute(&self) -> bool

Returns true if the Path is absolute, i.e., if it is independent of the current directory.

• On Unix, a path is absolute if it starts with the root, so is_absolute and has_root are equivalent.

• On Windows, a path is absolute if it has a prefix and starts with the root: c:\windows is absolute, while c:temp and \temp are not.

Examples

use std::path::Path;

assert!(!Path::new("foo.txt").is_absolute());

pub fn is_relative(&self) -> bool

Returns true if the Path is relative, i.e., not absolute.

See is_absolute’s documentation for more details.

Examples

use std::path::Path;

assert!(Path::new("foo.txt").is_relative());

pub fn has_root(&self) -> bool

Returns true if the Path has a root.

• On Unix, a path has a root if it begins with /.

• On Windows, a path has a root if it:

  • has no prefix and begins with a separator, e.g., \windows
  • has a prefix followed by a separator, e.g., c:\windows but not c:windows
  • has any non-disk prefix, e.g., \\server\share

Examples

use std::path::Path;

assert!(Path::new("/etc/passwd").has_root());

pub fn parent(&self) -> Option<&Path>

Returns the Path without its final component, if there is one.

This means it returns Some("") for relative paths with one component.

Returns None if the path terminates in a root or prefix, or if it’s the empty string.

Examples

use std::path::Path;

let path = Path::new("/foo/bar");
let parent = path.parent().unwrap();
assert_eq!(parent, Path::new("/foo"));

let grand_parent = parent.parent().unwrap();
assert_eq!(grand_parent, Path::new("/"));
assert_eq!(grand_parent.parent(), None);

let relative_path = Path::new("foo/bar");
let parent = relative_path.parent();
assert_eq!(parent, Some(Path::new("foo")));
let grand_parent = parent.and_then(Path::parent);
assert_eq!(grand_parent, Some(Path::new("")));
let great_grand_parent = grand_parent.and_then(Path::parent);
assert_eq!(great_grand_parent, None);

pub fn ancestors(&self) -> Ancestors<'_>

Produces an iterator over Path and its ancestors.

The iterator will yield the Path that is returned if the parent method is used zero or more times. That means, the iterator will yield &self, &self.parent().unwrap(), &self.parent().unwrap().parent().unwrap() and so on. If the parent method returns None, the iterator will do likewise. The iterator will always yield at least one value, namely &self.

Examples

use std::path::Path;

let mut ancestors = Path::new("/foo/bar").ancestors();
assert_eq!(ancestors.next(), Some(Path::new("/foo/bar")));
assert_eq!(ancestors.next(), Some(Path::new("/foo")));
assert_eq!(ancestors.next(), Some(Path::new("/")));
assert_eq!(ancestors.next(), None);

let mut ancestors = Path::new("../foo/bar").ancestors();
assert_eq!(ancestors.next(), Some(Path::new("../foo/bar")));
assert_eq!(ancestors.next(), Some(Path::new("../foo")));
assert_eq!(ancestors.next(), Some(Path::new("..")));
assert_eq!(ancestors.next(), Some(Path::new("")));
assert_eq!(ancestors.next(), None);

pub fn file_name(&self) -> Option<&OsStr>

Returns the final component of the Path, if there is one.

If the path is a normal file, this is the file name. If it’s the path of a directory, this is the directory name.

Returns None if the path terminates in ...

Examples

use std::path::Path;
use std::ffi::OsStr;

assert_eq!(Some(OsStr::new("bin")), Path::new("/usr/bin/").file_name());
assert_eq!(Some(OsStr::new("foo.txt")), Path::new("tmp/foo.txt").file_name());
assert_eq!(Some(OsStr::new("foo.txt")), Path::new("foo.txt/.").file_name());
assert_eq!(Some(OsStr::new("foo.txt")), Path::new("foo.txt/.//").file_name());
assert_eq!(None, Path::new("foo.txt/..").file_name());
assert_eq!(None, Path::new("/").file_name());

pub fn strip_prefix<P>(&self, base: P) -> Result<&Path, StripPrefixError>where P: AsRef<Path>,

Returns a path that, when joined onto base, yields self.

Errors

If base is not a prefix of self (i.e., starts_with returns false), returns Err.

Examples

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

let path = Path::new("/test/haha/foo.txt");

assert_eq!(path.strip_prefix("/"), Ok(Path::new("test/haha/foo.txt")));
assert_eq!(path.strip_prefix("/test"), Ok(Path::new("haha/foo.txt")));
assert_eq!(path.strip_prefix("/test/"), Ok(Path::new("haha/foo.txt")));
assert_eq!(path.strip_prefix("/test/haha/foo.txt"), Ok(Path::new("")));
assert_eq!(path.strip_prefix("/test/haha/foo.txt/"), Ok(Path::new("")));

assert!(path.strip_prefix("test").is_err());
assert!(path.strip_prefix("/haha").is_err());

let prefix = PathBuf::from("/test/");
assert_eq!(path.strip_prefix(prefix), Ok(Path::new("haha/foo.txt")));

pub fn starts_with<P>(&self, base: P) -> boolwhere P: AsRef<Path>,

Determines whether base is a prefix of self.

Only considers whole path components to match.

Examples

use std::path::Path;

let path = Path::new("/etc/passwd");

assert!(path.starts_with("/etc"));
assert!(path.starts_with("/etc/"));
assert!(path.starts_with("/etc/passwd"));
assert!(path.starts_with("/etc/passwd/")); // extra slash is okay
assert!(path.starts_with("/etc/passwd///")); // multiple extra slashes are okay

assert!(!path.starts_with("/e"));
assert!(!path.starts_with("/etc/passwd.txt"));

assert!(!Path::new("/etc/foo.rs").starts_with("/etc/foo"));

pub fn ends_with<P>(&self, child: P) -> boolwhere P: AsRef<Path>,

Determines whether child is a suffix of self.

Only considers whole path components to match.

Examples

use std::path::Path;

let path = Path::new("/etc/resolv.conf");

assert!(path.ends_with("resolv.conf"));
assert!(path.ends_with("etc/resolv.conf"));
assert!(path.ends_with("/etc/resolv.conf"));

assert!(!path.ends_with("/resolv.conf"));
assert!(!path.ends_with("conf")); // use .extension() instead

pub fn file_stem(&self) -> Option<&OsStr>

Extracts the stem (non-extension) portion of self.file_name.

The stem is:

• None, if there is no file name;
• The entire file name if there is no embedded .;
• The entire file name if the file name begins with . and has no other .s within;
• Otherwise, the portion of the file name before the final .

Examples

use std::path::Path;

assert_eq!("foo", Path::new("foo.rs").file_stem().unwrap());
assert_eq!("foo.tar", Path::new("foo.tar.gz").file_stem().unwrap());

See Also

This method is similar to Path::file_prefix, which extracts the portion of the file name before the first .

pub fn file_prefix(&self) -> Option<&OsStr>

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

Extracts the prefix of self.file_name.

The prefix is:

• None, if there is no file name;
• The entire file name if there is no embedded .;
• The portion of the file name before the first non-beginning .;
• The entire file name if the file name begins with . and has no other .s within;
• The portion of the file name before the second . if the file name begins with .

Examples

use std::path::Path;

assert_eq!("foo", Path::new("foo.rs").file_prefix().unwrap());
assert_eq!("foo", Path::new("foo.tar.gz").file_prefix().unwrap());

See Also

This method is similar to Path::file_stem, which extracts the portion of the file name before the last .

pub fn extension(&self) -> Option<&OsStr>

Extracts the extension (without the leading dot) of self.file_name, if possible.

The extension is:

• None, if there is no file name;
• None, if there is no embedded .;
• None, if the file name begins with . and has no other .s within;
• Otherwise, the portion of the file name after the final .

Examples

use std::path::Path;

assert_eq!("rs", Path::new("foo.rs").extension().unwrap());
assert_eq!("gz", Path::new("foo.tar.gz").extension().unwrap());

pub fn join<P>(&self, path: P) -> PathBufwhere P: AsRef<Path>,

Creates an owned PathBuf with path adjoined to self.

If path is absolute, it replaces the current path.

See PathBuf::push for more details on what it means to adjoin a path.

Examples

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

assert_eq!(Path::new("/etc").join("passwd"), PathBuf::from("/etc/passwd"));
assert_eq!(Path::new("/etc").join("/bin/sh"), PathBuf::from("/bin/sh"));

pub fn with_file_name<S>(&self, file_name: S) -> PathBufwhere S: AsRef<OsStr>,

Creates an owned PathBuf like self but with the given file name.

See PathBuf::set_file_name for more details.

Examples

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

let path = Path::new("/tmp/foo.txt");
assert_eq!(path.with_file_name("bar.txt"), PathBuf::from("/tmp/bar.txt"));

let path = Path::new("/tmp");
assert_eq!(path.with_file_name("var"), PathBuf::from("/var"));

pub fn with_extension<S>(&self, extension: S) -> PathBufwhere S: AsRef<OsStr>,

Creates an owned PathBuf like self but with the given extension.

See PathBuf::set_extension for more details.

Examples

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

let path = Path::new("foo.rs");
assert_eq!(path.with_extension("txt"), PathBuf::from("foo.txt"));

let path = Path::new("foo.tar.gz");
assert_eq!(path.with_extension(""), PathBuf::from("foo.tar"));
assert_eq!(path.with_extension("xz"), PathBuf::from("foo.tar.xz"));
assert_eq!(path.with_extension("").with_extension("txt"), PathBuf::from("foo.txt"));

pub fn components(&self) -> Components<'_>

Produces an iterator over the Components of the path.

When parsing the path, there is a small amount of normalization:

• Repeated separators are ignored, so a/b and a//b both have a and b as components.

• Occurrences of . are normalized away, except if they are at the beginning of the path. For example, a/./b, a/b/, a/b/. and a/b all have a and b as components, but ./a/b starts with an additional CurDir component.

• A trailing slash is normalized away, /a/b and /a/b/ are equivalent.

Note that no other normalization takes place; in particular, a/c and a/b/../c are distinct, to account for the possibility that b is a symbolic link (so its parent isn’t a).

Examples

use std::path::{Path, Component};
use std::ffi::OsStr;

let mut components = Path::new("/tmp/foo.txt").components();

assert_eq!(components.next(), Some(Component::RootDir));
assert_eq!(components.next(), Some(Component::Normal(OsStr::new("tmp"))));
assert_eq!(components.next(), Some(Component::Normal(OsStr::new("foo.txt"))));
assert_eq!(components.next(), None)

pub fn iter(&self) -> Iter<'_>

Produces an iterator over the path’s components viewed as OsStr slices.

For more information about the particulars of how the path is separated into components, see components.

Examples

use std::path::{self, Path};
use std::ffi::OsStr;

let mut it = Path::new("/tmp/foo.txt").iter();
assert_eq!(it.next(), Some(OsStr::new(&path::MAIN_SEPARATOR.to_string())));
assert_eq!(it.next(), Some(OsStr::new("tmp")));
assert_eq!(it.next(), Some(OsStr::new("foo.txt")));
assert_eq!(it.next(), None)

pub fn display(&self) -> Display<'_>

Returns an object that implements Display for safely printing paths that may contain non-Unicode data. This may perform lossy conversion, depending on the platform. If you would like an implementation which escapes the path please use Debug instead.

Examples

use std::path::Path;

let path = Path::new("/tmp/foo.rs");

println!("{}", path.display());

pub fn metadata(&self) -> Result<Metadata, Error>

Queries the file system to get information about a file, directory, etc.

This function will traverse symbolic links to query information about the destination file.

This is an alias to fs::metadata.

Examples

use std::path::Path;

let path = Path::new("/Minas/tirith");
let metadata = path.metadata().expect("metadata call failed");
println!("{:?}", metadata.file_type());

pub fn symlink_metadata(&self) -> Result<Metadata, Error>

Queries the metadata about a file without following symlinks.

This is an alias to fs::symlink_metadata.

Examples

use std::path::Path;

let path = Path::new("/Minas/tirith");
let metadata = path.symlink_metadata().expect("symlink_metadata call failed");
println!("{:?}", metadata.file_type());

pub fn canonicalize(&self) -> Result<PathBuf, Error>

Returns the canonical, absolute form of the path with all intermediate components normalized and symbolic links resolved.

This is an alias to fs::canonicalize.

Examples

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

let path = Path::new("/foo/test/../test/bar.rs");
assert_eq!(path.canonicalize().unwrap(), PathBuf::from("/foo/test/bar.rs"));

pub fn read_link(&self) -> Result<PathBuf, Error>

Reads a symbolic link, returning the file that the link points to.

This is an alias to fs::read_link.

Examples

use std::path::Path;

let path = Path::new("/laputa/sky_castle.rs");
let path_link = path.read_link().expect("read_link call failed");

pub fn read_dir(&self) -> Result<ReadDir, Error>

Returns an iterator over the entries within a directory.

The iterator will yield instances of io::Result<fs::DirEntry>. New errors may be encountered after an iterator is initially constructed.

This is an alias to fs::read_dir.

Examples

use std::path::Path;

let path = Path::new("/laputa");
for entry in path.read_dir().expect("read_dir call failed") {
    if let Ok(entry) = entry {
        println!("{:?}", entry.path());
    }
}

pub fn exists(&self) -> bool

Returns true if the path points at an existing entity.

Warning: this method may be error-prone, consider using try_exists() instead! It also has a risk of introducing time-of-check to time-of-use (TOCTOU) bugs.

This function will traverse symbolic links to query information about the destination file.

If you cannot access the metadata of the file, e.g. because of a permission error or broken symbolic links, this will return false.

Examples

use std::path::Path;
assert!(!Path::new("does_not_exist.txt").exists());

See Also

This is a convenience function that coerces errors to false. If you want to check errors, call Path::try_exists.

pub fn try_exists(&self) -> Result<bool, Error>

Returns Ok(true) if the path points at an existing entity.

This function will traverse symbolic links to query information about the destination file. In case of broken symbolic links this will return Ok(false).

As opposed to the exists() method, this one doesn’t silently ignore errors unrelated to the path not existing. (E.g. it will return Err(_) in case of permission denied on some of the parent directories.)

Note that while this avoids some pitfalls of the exists() method, it still can not prevent time-of-check to time-of-use (TOCTOU) bugs. You should only use it in scenarios where those bugs are not an issue.

Examples

use std::path::Path;
assert!(!Path::new("does_not_exist.txt").try_exists().expect("Can't check existence of file does_not_exist.txt"));
assert!(Path::new("/root/secret_file.txt").try_exists().is_err());

pub fn is_file(&self) -> bool

Returns true if the path exists on disk and is pointing at a regular file.

This function will traverse symbolic links to query information about the destination file.

If you cannot access the metadata of the file, e.g. because of a permission error or broken symbolic links, this will return false.

Examples

use std::path::Path;
assert_eq!(Path::new("./is_a_directory/").is_file(), false);
assert_eq!(Path::new("a_file.txt").is_file(), true);

See Also

This is a convenience function that coerces errors to false. If you want to check errors, call fs::metadata and handle its Result. Then call fs::Metadata::is_file if it was Ok.

When the goal is simply to read from (or write to) the source, the most reliable way to test the source can be read (or written to) is to open it. Only using is_file can break workflows like diff <( prog_a ) on a Unix-like system for example. See fs::File::open or fs::OpenOptions::open for more information.

pub fn is_dir(&self) -> bool

Returns true if the path exists on disk and is pointing at a directory.

This function will traverse symbolic links to query information about the destination file.

If you cannot access the metadata of the file, e.g. because of a permission error or broken symbolic links, this will return false.

Examples

use std::path::Path;
assert_eq!(Path::new("./is_a_directory/").is_dir(), true);
assert_eq!(Path::new("a_file.txt").is_dir(), false);

See Also

This is a convenience function that coerces errors to false. If you want to check errors, call fs::metadata and handle its Result. Then call fs::Metadata::is_dir if it was Ok.

pub fn is_symlink(&self) -> bool

Returns true if the path exists on disk and is pointing at a symbolic link.

This function will not traverse symbolic links. In case of a broken symbolic link this will also return true.

If you cannot access the directory containing the file, e.g., because of a permission error, this will return false.

Examples

use std::path::Path;
use std::os::unix::fs::symlink;

let link_path = Path::new("link");
symlink("/origin_does_not_exist/", link_path).unwrap();
assert_eq!(link_path.is_symlink(), true);
assert_eq!(link_path.exists(), false);

See Also

This is a convenience function that coerces errors to false. If you want to check errors, call fs::symlink_metadata and handle its Result. Then call fs::Metadata::is_symlink if it was Ok.

Trait Implementations

impl<'r> Clone for EnvPath<'r>

fn clone(&self) -> EnvPath<'r>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'r> Debug for EnvPath<'r>

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

Formats the value using the given formatter.

impl<'r> Default for EnvPath<'r>

fn default() -> EnvPath<'r>

Returns the “default value” for a type.

impl<'r> Deref for EnvPath<'r>

This implementation provides a read-only reference to the underlying path value of EnvPath.

type Target = Path

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'r> DerefMut for EnvPath<'r>

This implementation allows for mutable access to the underlying path value of EnvPath.

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for EnvPath<'_>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'r, const N: usize> From<&[&'r str; N]> for EnvPath<'r>

fn from(raw: &[&'r str; N]) -> Self

Examples

use envpath::EnvPath;

const ENV_PATH_RAW: [&str; 2] = ["$env: home", ".local"];
let v = EnvPath::from(&ENV_PATH_RAW).de();
dbg!(v.get_raw());
dbg!(v.display());

impl<'r, T: AsRef<str>> From<&[T]> for EnvPath<'r>

fn from(raw: &[T]) -> Self

The elements of an array slice can be of a type that implements AsRef<str>.

impl<'r> From<&Vec<&'r str, Global>> for EnvPath<'r>

fn from(raw: &Vec<&'r str>) -> Self

Examples

use envpath::EnvPath;

let path = EnvPath::from(&vec!["$env:home"]);
dbg!(path.get_raw());

impl<'r, const N: usize> From<[&'r str; N]> for EnvPath<'r>

fn from(raw: [&'r str; N]) -> Self

Examples

use envpath::EnvPath;

let arr = ["$env:home", "dev"];
let path: EnvPath = arr.into();
dbg!(path.de().display());

impl<'r> From<Vec<&'r str, Global>> for EnvPath<'r>

fn from(raw: Vec<&'r str>) -> Self

This is similar to new() when you use Vec<S> (S: Into<String>) as an argument to from(). But the difference is that new() automatically converts the raw to path, whereas from() or into() needs to be done manually.

Examples

use envpath::EnvPath;
let v: EnvPath = vec!["$env:home"].into();
dbg!(v.get_raw());
dbg!(v.de().display());

impl<'r> FromIterator<&'r str> for EnvPath<'r>

fn from_iter<I: IntoIterator<Item = &'r str>>(iter: I) -> Self

Creates a value from an iterator.

impl<'r> FromIterator<Cow<'r, str>> for EnvPath<'r>

fn from_iter<I: IntoIterator<Item = Cow<'r, str>>>(iter: I) -> Self

Creates a value from an iterator.

impl FromIterator<String> for EnvPath<'_>

fn from_iter<I: IntoIterator<Item = String>>(iter: I) -> Self

This is similar to new(). But the difference is that new() automatically converts the raw to path, whereas from_iter() needs to be done manually.

impl<'r> Hash for EnvPath<'r>

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<'r> Ord for EnvPath<'r>

fn cmp(&self, other: &EnvPath<'r>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<'r> PartialEq<EnvPath<'r>> for EnvPath<'r>

fn eq(&self, other: &EnvPath<'r>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<'r> PartialOrd<EnvPath<'r>> for EnvPath<'r>

fn partial_cmp(&self, other: &EnvPath<'r>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for EnvPath<'_>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where S: Serializer,

Just serialize the raw, the path is not needed. Since the value of $env needs to be fetched at runtime, path is not serialized by default.

If you really want to serialize the value of path, then you can create a new struct or other data structures. Here path_arr refers to raw and you need to manually set path_str to the value of path.

 use envpath::EnvPath;
 use std::path::PathBuf;

 struct Cfg<'a> {
   path_arr: EnvPath<'a>,
   path_str: PathBuf,
 }

impl<'r> Eq for EnvPath<'r>

impl<'r> StructuralEq for EnvPath<'r>

impl<'r> StructuralPartialEq for EnvPath<'r>