irox-tools 0.11.1

Stuff that should have been in the Rust STL, but aren't
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

// SPDX-License-Identifier: MIT
// Copyright 2025 IROX Contributors
//

use crate::cfg_feature_std;
use core::fmt::{Debug, Formatter};
use std::path::{Path, PathBuf};

pub struct TempFilePath {
    path: PathBuf,
}
impl Debug for TempFilePath {
    fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
        write!(f, "TempFile({})", self.path.display())
    }
}

impl Drop for TempFilePath {
    fn drop(&mut self) {
        let _ = std::fs::remove_file(&self.path);
    }
}
impl TempFilePath {
    pub fn new<T: AsRef<Path>>(path: T) -> Self {
        Self {
            path: path.as_ref().into(),
        }
    }
    /// Returns the temporary path.
    pub fn get_path(&self) -> &PathBuf {
        &self.path
    }

    cfg_feature_std! {
        /// Creates a new temporary file with the default prefix of `.tmpirxf_`
        /// that will be deleted when this object is dropped.
        pub fn new_tempfile() -> Result<Self, std::io::Error> {
            Self::new_tempfile_prefixed(".tmpirxf_")
        }
        /// Creates a new temporary file with the provided prefix that will be
        /// deleted when this object is dropped.
        pub fn new_tempfile_prefixed(prefix: &str) -> Result<Self, std::io::Error> {
            let prefix = crate::fs::clean_filename(&prefix);
            let tmpdir = std::env::temp_dir().join(format!("{prefix}{}", crate::uuid::UUID::new_random()));
            let p = std::fs::OpenOptions::new()
                .read(true)
                .write(true)
                .create_new(true)
                .truncate(true)
                .open(&tmpdir)?;
            drop(p);
            Ok(TempFilePath {
                path: tmpdir
            })
        }
        pub fn open(&self, opts: &std::fs::OpenOptions) -> Result<std::fs::File, std::io::Error> {
            opts.open(&self.path)
        }
        pub fn open_write_buffered(&self, opts: &std::fs::OpenOptions) -> Result<std::io::BufWriter<std::fs::File>, std::io::Error> {
            Ok(std::io::BufWriter::new(self.open(opts)?))
        }
        pub fn open_read_buffered(&self, opts: &std::fs::OpenOptions) -> Result<std::io::BufReader<std::fs::File>, std::io::Error> {
            Ok(std::io::BufReader::new(self.open(opts)?))
        }
    }
}
macro_rules! impl_from {
    ($dst:ident) => {
        impl From<PathBuf> for $dst {
            fn from(value: PathBuf) -> Self {
                Self { path: value }
            }
        }
        impl From<&PathBuf> for $dst {
            fn from(value: &PathBuf) -> Self {
                Self {
                    path: value.clone(),
                }
            }
        }
    };
}
impl_from!(TempFilePath);
pub struct TempDirPath {
    path: PathBuf,
}
impl Drop for TempDirPath {
    fn drop(&mut self) {
        let _ = std::fs::remove_dir_all(&self.path);
    }
}
impl Debug for TempDirPath {
    fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
        write!(f, "TempDir({})", self.path.display())
    }
}
impl TempDirPath {
    pub fn new<T: AsRef<Path>>(path: T) -> Self {
        Self {
            path: path.as_ref().into(),
        }
    }
    /// Returns the temporary path.
    pub fn get_path(&self) -> &PathBuf {
        &self.path
    }
    cfg_feature_std! {
        /// Creates a new temporary directory that will be removed upon dropping
        /// of this object with the default prefix of `.tmpirx_` and then a
        /// random UUID.
        pub fn new_temp_dir() -> Result<Self, std::io::Error> {
            Self::new_temp_dir_prefixed(".tmpirxd_")
        }
        /// Creates a new temporary directory that will be removed upon dropping
        /// of this object with the provided prefix and then a random UUID.
        pub fn new_temp_dir_prefixed(prefix: &str) -> Result<Self, std::io::Error> {
            let prefix = crate::fs::clean_filename(&prefix);
            let tmpdir = std::env::temp_dir().join(format!("{prefix}{}", crate::uuid::UUID::new_random()));
            std::fs::create_dir_all(&tmpdir)?;
            Ok(Self {
                path: tmpdir
            })
        }
        /// Creates a new temporary file within this directory and returns the
        /// path to that file.
        pub fn new_temp_file(&self) -> Result<TempFilePath, std::io::Error> {
            let f = self.path.join(crate::uuid::UUID::new_random().to_string());
            let p = std::fs::OpenOptions::new()
                .read(true)
                .write(true)
                .create_new(true)
                .truncate(true)
                .open(&f)?;
            drop(p);
            Ok(TempFilePath {
                path: f
            })
        }

    }
}
impl_from!(TempDirPath);