#path #relative-path #path-slash

sugar_path

Sugar functions for manipulating paths

14 releases (3 stable)

1.2.0 Apr 9, 2024
0.0.12 Feb 28, 2023
0.0.9 Nov 15, 2022
0.0.5 May 29, 2022
0.0.3 Mar 19, 2022

#170 in Rust patterns

Download history 547/week @ 2024-01-22 586/week @ 2024-01-29 259/week @ 2024-02-05 179/week @ 2024-02-12 401/week @ 2024-02-19 485/week @ 2024-02-26 866/week @ 2024-03-04 1075/week @ 2024-03-11 972/week @ 2024-03-18 1102/week @ 2024-03-25 1071/week @ 2024-04-01 2826/week @ 2024-04-08 858/week @ 2024-04-15 733/week @ 2024-04-22 558/week @ 2024-04-29 693/week @ 2024-05-06

2,942 downloads per month
Used in 11 crates (9 directly)

MIT license

22KB
272 lines

sugar_path

document crate version MIT

Sugar functions for manipulating paths.

Main functionalities

  • SugarPath::as_path makes it easy to convert T: Deref<Target = str> to Path and allows you to use methods of SugarPath on &str or String directly.
use std::path::Path;
use sugar_path::SugarPath;
assert_eq!("foo".as_path().join("bar"), Path::new("foo/bar"));
assert_eq!("foo/./bar/../baz".normalize(), "foo/baz".as_path());
use sugar_path::SugarPath;
#[cfg(target_family = "unix")]
let p = "./hello/world".as_path();
#[cfg(target_family = "windows")]
let p = ".\\hello\\world".as_path();
assert_eq!(p.to_slash().unwrap(), "./hello/world");
assert_eq!(p.to_slash_lossy(), "./hello/world");
use std::path::Path;
use sugar_path::SugarPath;
assert_eq!("foo/./bar/../baz".normalize(), "foo/baz".as_path());
  • SugarPath::relative allows you to get the relative path from the given path to the target path.
use sugar_path::SugarPath;
assert_eq!("/base".relative("/base/project"), "..".as_path());
assert_eq!("/base".relative("/var/lib"), "../../base".as_path());
use sugar_path::SugarPath;
let cwd = std::env::current_dir().unwrap();
assert_eq!("hello/world".absolutize(), cwd.join("hello").join("world"));
use sugar_path::SugarPath;
#[cfg(target_family = "unix")]
{
  assert_eq!("./world".absolutize_with("/hello"), "/hello/world".as_path());
  assert_eq!("../world".absolutize_with("/hello"), "/world".as_path());
}
#[cfg(target_family = "windows")]
{
  assert_eq!(".\\world".absolutize_with("C:\\hello"), "C:\\hello\\world".as_path());
  assert_eq!("..\\world".absolutize_with("C:\\hello"), "C:\\world".as_path());
}
  • For more details, please refer to the SugarPath.

No runtime deps