typed-path

What's Changed

• Remove AsRef<Path> for Cow<[u8]> and AsRef<Utf8Path> for Cow as they conflict with other libraries by @Its-Just-Nans in 7dc7403

New Contributors

• @Its-Just-Nans made their first contribution in 7dc7403

Full Changelog: v0.12.2...v0.12.3

• Remove AsRef<Path<T>> for Cow<[u8]> and AsRef<Utf8Path<T>> for Cow<str> as they conflict with other libraries (by Its-Just-Nans)

What's Changed

• Add proper license files to the repo by @sugoi1 in #58

New Contributors

• @sugoi1 made their first contribution in #58

Full Changelog: v0.12.1...v0.12.2

• Add missing LICENSE-APACHE and LICENSE-MIT files (#58)

What's Changed

• fix: enable wasip2 feature for wasm32-wasip2 target by @cdmurph32 in #57

New Contributors

• @cdmurph32 made their first contribution in #57

Full Changelog: v0.12.0...v0.12.1

• Enable wasip2 feature for wasm32-wasip2 target (#57)
• Fix unused import warning for std::io on wasm targets where the absolutize function (which uses io) is not available (#57)

What's Changed

• Fix type reference for parent() methods mentioned in #44
• Refactor utils to return platform paths instead of native paths
• Expose native and platform modules only when unix or windows by @AlexCharlton in #51
• Fix for platforms not supporting atomic loads by @Oakchris1955 in #52
• Update to be compliant with Rust Clippy 1.90.0

New Contributors

• @AlexCharlton made their first contribution in #51
• @Oakchris1955 made their first contribution in #52

Full Changelog: v0.11.0...v0.12.0

• Fix type reference for parent() methods mentioned in #44
• Refactor utils to return platform paths instead of native paths
• Expose native and platform mods only when unix or windows (#51)
• Fix for platforms not supporting atomic loads (#52)
• Update to be compliant with Rust Clippy 1.90.0

What's Changed

• Lift static restriction for Path methods by @fominok in #46
• Switch to dtolnay/rust-toolchain by @chipsenkbeil in #48
• Remove lifetime from Encoding and Utf8Encoding traits by @fominok in #47

As a consequence of #47, this bumps the minimum Rust version to 1.65.0.

New Contributors

• @fominok made their first contribution in #46

Full Changelog: v0.10.0...v0.11.0

• Lift restriction on static lifetime for checking if an encoding is representative of the platform (#46)
• Remove lifetime from Encoding and Utf8Encoding traits as GATs introduced in Rust 1.65.0 enable us to relax this requirement (#47)
• Switch to dtolnay/rust-toolchain to fix issues where minimum version of Rust wasn't being applied in tests (#48)

What's Changed

• Add PlatformEncoding and Utf8PlatformEncoding structs that mirror the
  functionality of NativeEncoding and Utf8NativeEncoding respectively, but
  as distinct structs instead of type aliases.
• Add PlatformPath and PlatformPathBuf type aliases that use PlatformEncoding.
• Add Utf8PlatformPath and Utf8PlatformPathBuf type aliases that use Utf8PlatformEncoding.
• Add AsRef<ffi::OsStr> for Utf8Path and Utf8PathBuf.
• Add TryAsRef<Utf8Path> for ffi::OsStr and ffi::OsString.
• Add From<Utf8PathBuf> for ffi::OsString.
• Remove implementation of TryAsRef<std::path::Path> for Path<T>.
• Remove implementation of TryAsRef<Path<T>> for std::path::Path.
• Remove implementation of TryAsRef<std::path::Path> for TypedPath.
• Remove implementation of TryAsRef<std::path::Path> for Utf8TypedPath.
• Remove implementation of TryFrom<Utf8TypedPathBuf> for std::path::PathBuf.
• Remove implementation of TryFrom<Utf8TypedPathBuf> for std::path::PathBuf.
• Remove implementation of From<Utf8UnixPathBuf> for std::path::PathBuf.
• Remove implementation of From<Utf8WindowsPathBuf> for std::path::PathBuf.

Full Changelog: v0.9.3...v0.10.0

• Add PlatformEncoding and Utf8PlatformEncoding structs that mirror the functionality of NativeEncoding and Utf8NativeEncoding respectively, but as distinct structs instead of type aliases.
• Add PlatformPath and PlatformPathBuf type aliases that use PlatformEncoding.
• Add Utf8PlatformPath and Utf8PlatformPathBuf type aliases that use Utf8PlatformEncoding.
• Add AsRef<ffi::OsStr> for Utf8Path and Utf8PathBuf.
• Add TryAsRef<Utf8Path> for ffi::OsStr and ffi::OsString.
• Add From<Utf8PathBuf> for ffi::OsString.
• Remove implementation of TryAsRef<std::path::Path> for Path<T>.
• Remove implementation of TryAsRef<Path<T>> for std::path::Path.
• Remove implementation of TryAsRef<std::path::Path> for TypedPath.
• Remove implementation of TryAsRef<std::path::Path> for Utf8TypedPath.
• Remove implementation of TryFrom<Utf8TypedPathBuf> for std::path::PathBuf.
• Remove implementation of TryFrom<Utf8TypedPathBuf> for std::path::PathBuf.
• Remove implementation of From<Utf8UnixPathBuf> for std::path::PathBuf.
• Remove implementation of From<Utf8WindowsPathBuf> for std::path::PathBuf.

What's Changed

• Change lib.rs permissions to remove execution by @danielmellado in #33

New Contributors

• @danielmellado made their first contribution in #33

Full Changelog: v0.9.2...v0.9.3

• Fix lib.rs file permissions to not be executable (#33).

What's Changed

• Fix TypedPathBuf::windows() and Utf8TypedPathBuf::windows() to properly return an instance of WindowsPathBuf and Utf8WindowsPathBuf respectively. Before this fix, the function instead returned a Unix path wrapper. (by @vnghia in #30)
• Address clippy warnings and update some metadata by @chipsenkbeil in #31
• Minimum Rust version of 1.58.1 is now specified via rust-version in Cargo.toml

New Contributors

• @vnghia made their first contribution in #30

Full Changelog: v0.9.1...v0.9.2

• Fix windows() function of TypedPathBuf and Utf8TypedPathBuf to properly return an instance of WindowsPathBuf and Utf8WindowsPathBuf respectively. Before this fix, the function instead returned a Unix path wrapper. (#30)
• Minimum Rust version of 1.58.1 is now explicitly set via rust-version.
• Address a variety of internal clippy warnings.

What's Changed

• add back missing derives by @stevefan1999-personal in #27

New Contributors

• @stevefan1999-personal made their first contribution in #27

Full Changelog: v0.9.0...v0.9.1

• Add derived Hash, PartialOrd, and Ord implementations for TypedPath and TypedPathBuf enumerations.

What's Changed

• Add typed-path versions for current_exe and temp_dir, including UTF8 variants by @simongoricar in #24

New Contributors

• @simongoricar made their first contribution in #24

Full Changelog: v0.8.0...v0.9.0

• Add current_exe and utf8_current_exe functions to the utils module to return native pathbufs wrapping the standard library paths.
• Add temp_dir and utf8_temp_dir functions to the utils module to return native pathbufs wrapping the standard library paths.

• Add push_checked function, which ensures that any path added to an existing PathBuf or TypedPathBuf must abide by the following rules:
  1. It cannot be an absolute path. Only relative paths allowed.
  2. In the case of Windows, it cannot start with a prefix like C:.
  3. All normal components of the path must contain only valid characters.
  4. If parent directory (..) components are present, they must not result in a path traversal attack (impacting the current path).
• Add join_checked function, which ensures that any path joied with an existing path follows the rules of push_checked
• Add with_encoding_checked function to ensure that the resulting path from an encoding conversion is still valid
• Add with_unix_encoding_checked and with_windows_encoding_checked functions as shortcuts to with_encoding_checked
• Add is_valid to Component and Utf8Component traits alongside Path and Utf8Path to indicate if a component/path is valid for the given encoding

• Support wasm family for compilation

• Support no_std environments, when default-features = false is set for the crate

• Refactor crate exports such that everything other than constants are now top-level exports
  • typed_path::unix::UnixComponent is now typed_path::UnixComponent
  • typed_path::unix::Utf8UnixComponent is now typed_path::Utf8UnixComponent
  • typed_path::windows::WindowsComponent is now typed_path::WindowsComponent
  • typed_path::windows::Utf8WindowsComponent is now typed_path::Utf8WindowsComponent
  • typed_path::windows::WindowsPrefix is now typed_path::WindowsPrefix
  • typed_path::windows::Utf8WindowsPrefix is now typed_path::Utf8WindowsPrefix
• Constants are now located within the constants module, broken out by unix and windows modules to house each set of constants
• TypedPath and Utf8TypedPath now match the method signature of Path for constructing self with ::new(...)
• Majority of methods available for Path and PathBuf have been ported over to TypedPath and TypedPathBuf
• Implement std::fmt::Display for Utf8UnixComponent, Utf8WindowsComponent, and Utf8TypedComponent

• Add TypedPath, Utf8TypedPath, TypedPathBuf, and Utf8TypedPathBuf enums to support code that can operate on both Windows and Unix paths

• Add From<&Utf8NativePath> for std::path::PathBuf

• Add AsRef<std::path::Path> for Utf8NativePath and Utf8NativePathBuf
• Add From<Utf8NativePathBuf> for std::path::PathBuf
• Add rustfmt.toml to dictate formatting using cargo +nightly fmt --all

• Add normalize method to Path and Utf8Path to support resolving . and .. across Windows and Unix encodings
• Add is_parent and is_current methods to Component and Utf8Component traits with implementations for both Unix and Windows component implementations
• Add root, parent, and current static methods to Component and Utf8Component traits to support creating the instances from generics
• Add absolutize to both normalize the path and - in the case of relative paths - prefix the path with the current working directory
• Add with_encoding to Path and Utf8Path support converting between the Unix and Windows encoding types
• Add utils::current_dir and utils::utf8_current_dir to retrieve the current working directory as either a PathBuf or Utf8PathBuf
• Add with_unix_encoding and with_windows_encoding to Path and Utf8Path support converting between the Unix and Windows encoding types
• Add has_unix_encoding and has_windows_encoding to Path and Utf8Path to detect explicit encodings

• Fix implementation of Display for Utf8Path to use underlying str Display instead of Debug

• Fix joining of empty path with relative path resulting in absolute path when using UnixPath::join or Utf8UnixPath::join (#6)

• Add Clone implementation for Box<Path<T>> and Box<Utf8Path<T>>
• Fix Clone implementation for PathBuf<T> and Utf8PathBuf<T> requiring a clone implementation for the encoding, which is not necessary (#5)
• Update Debug implementation for Path<T>, Utf8Path<T>, PathBuf<T>, and Utf8PathBuf<T> to no longer require debug implementation for encoding, which is not necessary
• Add label method to encoding implementations, used for debugging purposes

• Update README with more UTF8 examples and add proper testing of README examples via doctest

• Added UTF-8 variants of Path, PathBuf, Components, Component, and other data structures to support str versus [u8]
• Remove requirements of Clone, Debug, Display, and Sized on Encoding and subsequent implementations UnixEncoding and WindowsEncoding

Initial release of the library!