devela 0.27.0

A development layer of coherence.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

// devela::sys::fs::path::ext
//
//! An extension trait for [`Path`] and [`PathBuf`].
//

use crate::{IoResult, Path, PathBuf};
use std::path::{MAIN_SEPARATOR, MAIN_SEPARATOR_STR, absolute, is_separator};

/// Marker trait to prevent downstream implementations of the [`PathExt`] trait.
trait Sealed {}
impl Sealed for Path {}
impl Sealed for PathBuf {}

#[doc = crate::_tags!(fs)]
/// Extension trait providing additional methods for [`Path`] and [`PathBuf`].
#[rustfmt::skip]
#[cfg_attr(nightly_doc, doc(notable_trait))]
#[expect(private_bounds, reason = "Sealed")]
pub trait PathExt: Sealed {
    /// The primary separator string of path components for the current platform.
    ///
    /// See `std::path::`[MAIN_SEPARATOR_STR].
    const SEPARATOR: &str = MAIN_SEPARATOR_STR;

    /// The primary separator char of path components for the current platform.
    ///
    /// See `std::path::`[MAIN_SEPARATOR].
    const SEPARATOR_CHAR: char = MAIN_SEPARATOR;

    /// Makes the given path absolute without accessing the filesystem.
    ///
    /// See `std::path::`[`absolute`] and [`Self::to_absolute`].
    fn absolute<P: AsRef<Path>>(path: P) -> IoResult<PathBuf> {
        absolute(path)
    }

    /// Makes the current path absolute without accessing the filesystem.
    ///
    /// See `std::path::`[`absolute`] and [`Self::absolute`].
    fn to_absolute(&self) -> IoResult<PathBuf>;

    /// Determines whether the character is one of the permitted path separators
    /// for the current platform.
    ///
    /// See `std::path::`[`is_separator`].
    #[must_use]
    fn is_separator(c: char) -> bool {
        is_separator(c)
    }

}
impl PathExt for Path {
    fn to_absolute(&self) -> IoResult<PathBuf> {
        absolute(self)
    }
}
impl PathExt for PathBuf {
    fn to_absolute(&self) -> IoResult<PathBuf> {
        absolute(self)
    }
}