smart-path 0.3.0

Wrapper to extend PathBuf's functionality
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

# Smart PathBuf

[![Build Status](https://travis-ci.com/DevinR528/smart-pathbuf.svg?branch=master)](https://travis-ci.com/DevinR528/smart-pathbuf)
[![Latest Version](https://img.shields.io/crates/v/smart-pathbuf.svg)](https://crates.io/crates/toml)

A wrapper around rust's `PathBuf` adding convenience methods for manipulating paths. `SmartPathBuf`
has all the same functionality as `PathBuf` and more, it is an extension and will always maintain feature
parity with `PathBuf`. `SmartPathBuf` will add some overhead as it needs to keep more information around,
I will work to keep it as low as possible.

## Use
```toml
smart-pathbuf = "0.3"
```
The `PathBuf` methods that are nightly only now are behind a feature flag and can
be enabled.
```toml
smart-pathbuf = { version = "0.3", features = ["unstable"] }
```
As std lib stabilize these features so will this crate.

## Examples
No more calling multiple `.pop()`.
```rust
use smart_path::SmartPathBuf;

let dir = std::env::current_dir().expect("failed");
let mut s_path = SmartPathBuf::from(&dir);
//or just s_path = SmartPathBuf::from(&dir);
// s_path.push(&dir);

s_path.push("to/file");
do_something(&s_path); // "current/dir/to/file"

// remove segments up to the initial path given
s_path.initial();
// or s_path.pop_last();
// "current/dir"
s_path.push("another/file");
do_more(&s_path);
```

`SmartPathBuf` can be manipulated with indexes and ranges.
```rust
 let mut path = SmartPathBuf::from("hello/world/bye");
 let p = path.range(..path.len() - 1);
 assert_eq!(p.as_path(), PathBuf::from("hello/world").as_path());
```
Or slice from the middle to end `SmartPathBuf` will handle slicing absolute paths
returning a non absolute path.

## Contribute
[Pull requests](https://github.com/DevinR528/smart-pathbuf/pulls) or [suggestions](https://github.com/DevinR528/smart-pathbuf/issues) welcome!