Skip to content

Commit

Permalink
bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
germangb committed May 22, 2019
1 parent 9ff3a3c commit e7887fe
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 10 deletions.
1 change: 0 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ exclude = [".pages/*"]
edition = "2018"

[dependencies]
failure = "0.1.5"
tar_ = { package = "tar", version = "0.4.23", optional = true }
zip_ = { package = "zip", version = "0.5.2", optional = true }
flate2 = { version = "1.0.7", optional = true }
Expand Down
9 changes: 3 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ Supports reading from both the native filesystem, as well as Tar & Zip archives.

```toml
[dependencies]
mini-fs = "0.1"
mini-fs = "0.2"
```

An example showcasing the API:

```rust
use mini_fs::prelude::*;
use mini_fs::{Store, LocalFs, TarFs, MiniFs};
use mini_fs::{LocalFs, TarFs, MiniFs};

// Declare some file systems.
let local = LocalFs::pwd()?;
Expand All @@ -31,9 +31,6 @@ let mut fs = MiniFs::new()

// To open (read) files:
let file = fs.open("/data/example.gif")?;

// Unmount it when you're done (drops the file system)
fs.umount("/data");
```

## Overlay filesystem
Expand All @@ -59,7 +56,7 @@ assert!(files.open("/files/example.txt").is_ok()); // this "example.txt" is from
assert!(files.open("/files/hello.txt").is_ok());
```

Note that if you tried to first mount `a`, followed by `b` on the same mount point, the first one would be shadowed by `b`.
Note that if you tried to first mount `a`, followed by `b` under the same mount point, the first one would be shadowed by `b`.

## Extensible

Expand Down
4 changes: 2 additions & 2 deletions src/index.rs
Original file line number Diff line number Diff line change
Expand Up @@ -171,8 +171,8 @@ fn get<'a, M>(mut parts: VecDeque<&OsStr>, node: &'a Node<M>) -> Option<&'a M> {
}
}

/// Normalizes path by removing references to the parent (`..`) and the current
/// (`.`) directory.
/// Normalizes path by removing any references to the parent (`..`) and the
/// current (`.`) directory.
///
/// ```
/// use mini_fs::index::normalize_path;
Expand Down
2 changes: 1 addition & 1 deletion src/tar.rs
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,6 @@ impl<T: Read + Seek> TarFs<T> {
/// Having an index allows you to list the contents of the archive using the
/// entries_path and entries methods.
pub fn index(self) -> io::Result<Self> {
unimplemented!();
unimplemented!("TarFs indexing hasn't been implemented yet.");
}
}

0 comments on commit e7887fe

Please sign in to comment.