Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rhysd/path-slash
Tiny Rust library to convert a file path from/to slash path
https://github.com/rhysd/path-slash
backslash path rust slash
Last synced: about 2 hours ago
JSON representation
Tiny Rust library to convert a file path from/to slash path
- Host: GitHub
- URL: https://github.com/rhysd/path-slash
- Owner: rhysd
- License: mit
- Created: 2018-12-30T07:26:28.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-08-08T03:35:00.000Z (over 2 years ago)
- Last Synced: 2024-12-23T18:13:01.829Z (7 days ago)
- Topics: backslash, path, rust, slash
- Language: Rust
- Homepage: https://crates.io/crates/path-slash
- Size: 58.6 KB
- Stars: 58
- Watchers: 5
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Rust library to convert a file path from/to slash path
======================================================
[![crates.io][crates-io-badge]][crates-io]
[![documentation][doc-badge]][doc]
[![CI][ci-badge]][ci]
[![codecov-badge][]][codecov]
[`path-slash`][crates-io] is a tiny library to convert a file path (e.g. `foo/bar`, `foo\bar` or
`C:\foo\bar`) from/to slash path (e.g. `foo/bar`, `C:/foo/bar`).
On Unix-like OS, path separator is slash `/` by default. One may want to convert a Windows path. But on
Windows, file path separator `\` needs to be replaced with slash `/` (and of course `\`s for escaping
characters should not be replaced).
Supported Rust version is 1.38.0 or later.
This package was inspired by Go's [`path/filepath.FromSlash`](https://pkg.go.dev/path/filepath#FromSlash)
and [`path/filepath.ToSlash`](https://pkg.go.dev/path/filepath#ToSlash).
## Usage
`path_slash::PathExt`, `path_slash::PathBufExt` and `path_slash::CowExt` traits are defined. By using them,
`std::path::Path`, `std::path::PathBuf` and `std::borrow::Cow<'_, Path>` gain some methods and associated functions.
- `PathExt`
- `Path::to_slash(&self) -> Option>`
- `Path::to_slash_lossy(&self) -> Cow<'_, str>`
- `PathBufExt`
- `PathBuf::from_slash>(s: S) -> PathBuf`
- `PathBuf::from_slash_lossy>(s: S) -> PathBuf`
- `PathBuf::from_backslash>(s: S) -> PathBuf`
- `PathBuf::from_backslash_lossy>(s: S) -> PathBuf`
- `PathBuf::to_slash(&self) -> Option>`
- `PathBuf::to_slash_lossy(&self) -> Cow<'_, str>`
- `CowExt`
- `Cow::::from_slash(s: &str) -> Cow<'_, Path>`
- `Cow::::from_slash_lossy(s: &OsStr) -> Cow<'_, Path>`
- `Cow::::from_backslash(s: &str) -> Cow<'_, Path>`
- `Cow::::from_backslash_lossy(s: &OsStr) -> Cow<'_, Path>`
- `Cow::::to_slash(&self) -> Option>`
- `Cow::::to_slash_lossy(&self) -> Cow<'_, str>`
```rust
fn example_path_ext() {
// Trait for extending std::path::Path
use path_slash::PathExt as _;
let p = Path::from_slash("foo/bar/piyo.txt");
// On Windows
assert_eq!(p, Path::new(r"foo\bar\piyo.txt"));
// Convert to slash path
assert_eq!(p.to_slash().unwrap(), "foo/bar/piyo.txt");
assert_eq!(p.to_slash_lossy(), "foo/bar/piyo.txt");
}
fn example_pathbuf_ext() {
// Trait for extending std::path::PathBuf
use path_slash::PathBufExt as _;
// On Windows
let p = PathBuf::from_slash("foo/bar/piyo.txt");
assert_eq!(p, PathBuf::from(r"foo\bar\piyo.txt"));
// Convert to slash path
assert_eq!(p.to_slash().unwrap(), "foo/bar/piyo.txt");
assert_eq!(p.to_slash_lossy(), "foo/bar/piyo.txt");
}
fn example_cow_ext() {
// Trait for extending std::borrow::Cow<'_, Path>
use path_slash::CowExt as _;
let p = Cow::from_slash("foo/bar/piyo.txt");
// On Windows
assert_eq!(p, Cow::Owned(PathBuf::from(r"foo\bar\piyo.txt")));
// On non-Windows
assert_eq!(p, Cow::Borrowed(Path::new("foo/bar/piyo.txt")));
// Convert to slash path
assert_eq!(p.to_slash().unwrap(), "foo/bar/piyo.txt");
assert_eq!(p.to_slash_lossy(), "foo/bar/piyo.txt");
}
```
Please read [documents][doc] for more details.
## Installation
Add `path-slash` to dependencies:
```toml
[dependencies]
path-slash = "0.x"
```
## License
[the MIT License](LICENSE.txt)
[doc-badge]: https://docs.rs/path-slash/badge.svg
[doc]: https://docs.rs/path-slash
[crates-io-badge]: https://img.shields.io/crates/v/path-slash.svg
[crates-io]: https://crates.io/crates/path-slash
[ci]: https://github.com/rhysd/path-slash/actions?query=workflow%3ACI
[ci-badge]: https://github.com/rhysd/path-slash/workflows/CI/badge.svg?branch=master&event=push
[codecov-badge]: https://codecov.io/gh/rhysd/path-slash/branch/master/graph/badge.svg?token=6f7QWopfz4
[codecov]: https://codecov.io/gh/rhysd/path-slash