Struct smart_path::SmartPathBuf

pub struct SmartPathBuf { /* fields omitted */ }

Methods

impl SmartPathBuf

pub fn new() -> SmartPathBuf

Constructs a new SmartPathBuf.

Examples

use smart_path::SmartPathBuf;
 
let mut smart_path = SmartPathBuf::new();

pub fn as_path(&self) -> &Path

Returns a Path same as as_ref but more explicit.

pub fn len(&self) -> usize

len is the number of segments, on "*nix" systems if absolute this includes "/".

pub fn is_empty(&self) -> bool

If there are no segments in this path returns true.

pub fn push<P: AsRef<Path>>(&mut self, path: P)

When pushing segments to a new SmartPathBuf first push sets the initial size, using one of the from methods also sets initial size.

Examples

use std::path::PathBuf;
use smart_path::SmartPathBuf;

let mut path = SmartPathBuf::new();
path.push("hello/world/bye");
// or
let mut path = SmartPathBuf::from("hello/world/bye");

path.push("more/stuff");
path.initial();
assert_eq!(path.as_path(), PathBuf::from("hello/world/bye").as_path());

pub fn pop(&mut self) -> bool

Remove segment from end of path.

pub fn pop_last(&mut self)

Remove the last added segment(s) from end of path.

Examples

use std::path::PathBuf;
use smart_path::SmartPathBuf;

let mut path = SmartPathBuf::new();
path.push("hello/world/bye");
path.push("more/stuff");
path.pop_last();
assert_eq!(path.as_path(), PathBuf::from("hello/world/bye").as_path());

pub fn initial(&mut self)

Resets SmartPathBuf to the initial path.

Examples

use std::path::PathBuf;
use smart_path::SmartPathBuf;

let mut path = SmartPathBuf::new();
path.push("hello/world/bye");
path.push("more/stuff");
path.push("even/more");
path.initial();
assert_eq!(path.as_path(), PathBuf::from("hello/world/bye").as_path());

pub fn set_file_name<S: AsRef<OsStr>>(&mut self, file_name: S)

Updates file_name to the given file name.

If file_name was None, this is equivalent to pushing another segment that is a file name.

Otherwise it is equivalent to calling pop and then pushing a file name.

Examples

use smart_path::SmartPathBuf;

let mut buf = SmartPathBuf::from("/");
assert!(buf.file_name() == None);
buf.set_file_name("bar");
assert!(buf == SmartPathBuf::from("/bar"));
assert!(buf.file_name().is_some());
buf.set_file_name("baz.txt");
assert!(buf == SmartPathBuf::from("/baz.txt"));

pub fn set_extension<S: AsRef<OsStr>>(&mut self, extension: S) -> bool

Updates extension to the given extension.

Returns false and does nothing if file_name is None, returns true and updates the extension otherwise.

Examples

use std::path::Path;
use smart_path::SmartPathBuf;

let mut p = SmartPathBuf::from("/feel/the");

p.set_extension("force");
assert_eq!(Path::new("/feel/the.force"), p.as_path());

p.set_extension("dark_side");
assert_eq!(Path::new("/feel/the.dark_side"), p.as_path());

pub fn into_boxed_path(self) -> Box<Path>

Boxes a Path up for you.

pub fn into_os_string(self) -> OsString

Returns a new OsString.

Trait Implementations

impl PathRange<RangeFull> for SmartPathBuf

fn range(&self, range: RangeFull) -> Self

Returns a new SmartPath from the range provided

impl PathRange<RangeTo<usize>> for SmartPathBuf

fn range(&self, range: RangeTo<usize>) -> Self

Returns a new SmartPath from the range provided

impl PathRange<RangeFrom<usize>> for SmartPathBuf

fn range(&self, range: RangeFrom<usize>) -> Self

Returns a new SmartPath from the range provided

impl PathRange<Range<usize>> for SmartPathBuf

fn range(&self, range: Range<usize>) -> Self

Returns a new SmartPath from the range provided

impl<'_, T: ?Sized> From<&'_ T> for SmartPathBuf where
    T: AsRef<OsStr>, 

fn from(s: &T) -> SmartPathBuf

Performs the conversion.

impl From<OsString> for SmartPathBuf

fn from(s: OsString) -> SmartPathBuf

Performs the conversion.

impl From<String> for SmartPathBuf

fn from(s: String) -> SmartPathBuf

Performs the conversion.

impl From<PathBuf> for SmartPathBuf

fn from(s: PathBuf) -> SmartPathBuf

Performs the conversion.

impl<P: AsRef<Path>> Extend<P> for SmartPathBuf

fn extend<I: IntoIterator<Item = P>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

impl<'a> IntoIterator for &'a SmartPathBuf

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) -> Iter<'a>

Creates an iterator from a value.

impl Clone for SmartPathBuf

fn clone(&self) -> SmartPathBuf

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for SmartPathBuf

fn default() -> Self

Constructs an empty SmartPathBuf.

impl Eq for SmartPathBuf

impl Ord for SmartPathBuf

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl PartialEq<SmartPathBuf> for SmartPathBuf

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, 'b> PartialEq<PathBuf> for SmartPathBuf

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, 'b> PartialEq<SmartPathBuf> for PathBuf

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, 'b> PartialEq<Path> for SmartPathBuf

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, 'b> PartialEq<SmartPathBuf> for Path

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, 'b> PartialEq<&'a Path> for SmartPathBuf

fn eq(&self, other: &&'a Path) -> bool

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, 'b> PartialEq<SmartPathBuf> for &'a Path

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, 'b> PartialEq<OsStr> for SmartPathBuf

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, 'b> PartialEq<SmartPathBuf> for OsStr

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, 'b> PartialEq<&'a OsStr> for SmartPathBuf

fn eq(&self, other: &&'a OsStr) -> bool

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, 'b> PartialEq<SmartPathBuf> for &'a OsStr

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, 'b> PartialEq<Cow<'a, OsStr>> for SmartPathBuf

fn eq(&self, other: &Cow<'a, OsStr>) -> bool

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, 'b> PartialEq<SmartPathBuf> for Cow<'a, OsStr>

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, 'b> PartialEq<OsString> for SmartPathBuf

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, 'b> PartialEq<SmartPathBuf> for OsString

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<SmartPathBuf> for SmartPathBuf

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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<'a, 'b> PartialOrd<PathBuf> for SmartPathBuf

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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<'a, 'b> PartialOrd<SmartPathBuf> for PathBuf

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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<'a, 'b> PartialOrd<Path> for SmartPathBuf

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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<'a, 'b> PartialOrd<SmartPathBuf> for Path

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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<'a, 'b> PartialOrd<&'a Path> for SmartPathBuf

fn partial_cmp(&self, other: &&'a Path) -> Option<Ordering>

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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<'a, 'b> PartialOrd<SmartPathBuf> for &'a Path

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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<'a, 'b> PartialOrd<OsStr> for SmartPathBuf

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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<'a, 'b> PartialOrd<SmartPathBuf> for OsStr

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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<'a, 'b> PartialOrd<&'a OsStr> for SmartPathBuf

fn partial_cmp(&self, other: &&'a OsStr) -> Option<Ordering>

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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<'a, 'b> PartialOrd<SmartPathBuf> for &'a OsStr

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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<'a, 'b> PartialOrd<Cow<'a, OsStr>> for SmartPathBuf

fn partial_cmp(&self, other: &Cow<'a, OsStr>) -> Option<Ordering>

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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<'a, 'b> PartialOrd<SmartPathBuf> for Cow<'a, OsStr>

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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<'a, 'b> PartialOrd<OsString> for SmartPathBuf

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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<'a, 'b> PartialOrd<SmartPathBuf> for OsString

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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 Debug for SmartPathBuf

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

Formats the value using the given formatter.

impl FromStr for SmartPathBuf

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Deref for SmartPathBuf

type Target = Path

The resulting type after dereferencing.

fn deref(&self) -> &Path

Dereferences the value.

impl Index<usize> for SmartPathBuf

type Output = OsString

The returned type after indexing.

fn index(&self, idx: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<Range<usize>> for SmartPathBuf

type Output = [OsString]

The returned type after indexing.

fn index(&self, rng: Range<usize>) -> &Self::Output

On unix the / is always the first element in a Path

impl Index<RangeFull> for SmartPathBuf

type Output = [OsString]

The returned type after indexing.

fn index(&self, rng: RangeFull) -> &Self::Output

On unix the / is always the first element in a Path

impl Index<RangeFrom<usize>> for SmartPathBuf

type Output = [OsString]

The returned type after indexing.

fn index(&self, rng: RangeFrom<usize>) -> &Self::Output

On unix the / is always the first element in a Path

impl Index<RangeTo<usize>> for SmartPathBuf

type Output = [OsString]

The returned type after indexing.

fn index(&self, rng: RangeTo<usize>) -> &Self::Output

On unix the / is always the first element in a Path

impl IndexMut<usize> for SmartPathBuf

fn index_mut(&mut self, idx: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<Range<usize>> for SmartPathBuf

fn index_mut(&mut self, rng: Range<usize>) -> &mut Self::Output

On unix the / is always the first element in a Path

impl IndexMut<RangeFull> for SmartPathBuf

fn index_mut(&mut self, rng: RangeFull) -> &mut Self::Output

On unix the / is always the first element in a Path

impl IndexMut<RangeFrom<usize>> for SmartPathBuf

fn index_mut(&mut self, rng: RangeFrom<usize>) -> &mut Self::Output

On unix the / is always the first element in a Path

impl IndexMut<RangeTo<usize>> for SmartPathBuf

fn index_mut(&mut self, rng: RangeTo<usize>) -> &mut Self::Output

On unix the / is always the first element in a Path

impl Hash for SmartPathBuf

fn hash<H: Hasher>(&self, h: &mut H)

Hashes the inner Path value not SmartPathBuf.

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

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

impl<P: AsRef<Path>> FromIterator<P> for SmartPathBuf

fn from_iter<I: IntoIterator<Item = P>>(iter: I) -> SmartPathBuf

Creates a value from an iterator.

impl Borrow<Path> for SmartPathBuf

fn borrow(&self) -> &Path

Immutably borrows from an owned value.