devela/sys/fs/path/
ext.rs

Help
1// devela::sys::fs::path::ext
2//
3//! An extension trait for [`Path`] and [`PathBuf`].
4//
5
6use crate::{IoResult, Path, PathBuf};
7use std::path::{absolute, is_separator, MAIN_SEPARATOR, MAIN_SEPARATOR_STR};
8
9/// Marker trait to prevent downstream implementations of the [`ExtPath`] trait.
10trait Sealed {}
11impl Sealed for Path {}
12impl Sealed for PathBuf {}
13
14#[doc = crate::TAG_NAMESPACE!()]
15/// Extension trait providing additional methods for [`Path`] and [`PathBuf`].
16#[rustfmt::skip]
17#[cfg_attr(feature = "nightly_doc", doc(notable_trait))]
18#[expect(private_bounds, reason = "Sealed")]
19pub trait ExtPath: Sealed {
20    /// The primary separator string of path components for the current platform.
21    ///
22    /// See `std::path::`[MAIN_SEPARATOR_STR].
23    const SEPARATOR: &str = MAIN_SEPARATOR_STR;
24
25    /// The primary separator char of path components for the current platform.
26    ///
27    /// See `std::path::`[MAIN_SEPARATOR].
28    const SEPARATOR_CHAR: char = MAIN_SEPARATOR;
29
30    /// Makes the given path absolute without accessing the filesystem.
31    ///
32    /// See `std::path::`[`absolute`] and [`Self::to_absolute`].
33    fn absolute<P: AsRef<Path>>(path: P) -> IoResult<PathBuf> {
34        absolute(path)
35    }
36
37    /// Makes the current path absolute without accessing the filesystem.
38    ///
39    /// See `std::path::`[`absolute`] and [`Self::absolute`].
40    fn to_absolute(&self) -> IoResult<PathBuf>;
41
42    /// Determines whether the character is one of the permitted path separators
43    /// for the current platform.
44    ///
45    /// See `std::path::`[`is_separator`].
46    #[must_use]
47    fn is_separator(c: char) -> bool {
48        is_separator(c)
49    }
50
51}
52impl ExtPath for Path {
53    fn to_absolute(&self) -> IoResult<PathBuf> {
54        absolute(self)
55    }
56}
57impl ExtPath for PathBuf {
58    fn to_absolute(&self) -> IoResult<PathBuf> {
59        absolute(self)
60    }
61}
devela/sys/fs/path/ext.rs

devela/sys/fs/path/
ext.rs
