Struct cachedir::CacheDir

pub struct CacheDir { /* fields omitted */ }

This structure holds the PathBuf returned from CacheDirConfig.

It derefs to PathBuf and implements most of the same traits as PathBuf.

Examples

let cache_dir: CacheDir = CacheDirConfig::new("example").get_cache_dir().unwrap();

fn as_path(path: &Path) {}

fn into_path_buf<P: Into<PathBuf>>(path: P) {
    let _path_buf: PathBuf = path.into();
}

fn as_ref<P: AsRef<OsStr>>(path: P) {
    let _os_str: &OsStr = path.as_ref();
}

as_path(cache_dir.as_path());
into_path_buf(cache_dir.clone());
as_ref(cache_dir.clone());

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

Methods

impl CacheDir

fn into_path_buf(self) -> PathBuf

let path: PathBuf = CacheDirConfig::new("example")
                                   .get_cache_dir().unwrap()
                                   .into_path_buf();

Methods from Deref<Target = PathBuf>

fn as_path(&self) -> &Path

Coerces to a Path slice.

Examples

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

let p = PathBuf::from("/test");
assert_eq!(Path::new("/test"), p.as_path());

fn into_os_string(self) -> OsString

Consumes the PathBuf, yielding its internal OsString storage.

Examples

use std::path::PathBuf;

let p = PathBuf::from("/the/head");
let os_str = p.into_os_string();

fn into_boxed_path(self) -> Box<Path>

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

Converts this PathBuf into a boxed Path.

Trait Implementations

impl Deref for CacheDir

type Target = PathBuf

The resulting type after dereferencing

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

The method called to dereference a value

impl Into<PathBuf> for CacheDir

fn into(self) -> PathBuf

Performs the conversion.

impl Into<OsString> for CacheDir

fn into(self) -> OsString

Performs the conversion.

impl Borrow<PathBuf> for CacheDir

fn borrow(&self) -> &PathBuf

Immutably borrows from an owned value.

impl Borrow<Path> for CacheDir

fn borrow(&self) -> &Path

Immutably borrows from an owned value.

impl Borrow<OsStr> for CacheDir

fn borrow(&self) -> &OsStr

Immutably borrows from an owned value.

impl AsRef<PathBuf> for CacheDir

fn as_ref(&self) -> &PathBuf

Performs the conversion.

impl AsRef<Path> for CacheDir

fn as_ref(&self) -> &Path

Performs the conversion.

impl AsRef<OsStr> for CacheDir

fn as_ref(&self) -> &OsStr

Performs the conversion.

impl<'a> IntoIterator for &'a CacheDir

type Item = &'a OsStr

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Debug for CacheDir

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for CacheDir

fn clone(&self) -> CacheDir

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for CacheDir

fn eq(&self, __arg_0: &CacheDir) -> bool

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

fn ne(&self, __arg_0: &CacheDir) -> bool

This method tests for !=.

impl Eq for CacheDir

impl Hash for CacheDir

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

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialOrd for CacheDir

fn partial_cmp(&self, __arg_0: &CacheDir) -> Option<Ordering>

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

fn lt(&self, __arg_0: &CacheDir) -> bool

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

fn le(&self, __arg_0: &CacheDir) -> bool

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

fn gt(&self, __arg_0: &CacheDir) -> bool

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

fn ge(&self, __arg_0: &CacheDir) -> bool

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

impl Ord for CacheDir

fn cmp(&self, __arg_0: &CacheDir) -> Ordering

This method returns an Ordering between self and other.