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
use crate::fs::DirOptions;
use std::fmt;
/// A builder used to create directories in various manners.
///
/// This corresponds to [`std::fs::DirBuilder`].
///
/// Unlike `std::fs::DirBuilder`, this API has no `DirBuilder::create`, because
/// creating directories requires a capability. Use [`Dir::create_dir_with`]
/// instead.
///
/// [`Dir::create_dir_with`]: https://docs.rs/cap-std/latest/cap_std/fs/struct.Dir.html#method.create_dir_with
///
/// <details>
/// We need to define our own version because the libstd `DirBuilder` doesn't
/// have public accessors that we can use.
/// </details>
pub struct DirBuilder {
pub(crate) recursive: bool,
pub(crate) options: DirOptions,
}
impl DirBuilder {
/// Creates a new set of options with default mode/security settings for
/// all platforms and also non-recursive.
///
/// This corresponds to [`std::fs::DirBuilder::new`].
#[allow(clippy::new_without_default)]
#[inline]
pub const fn new() -> Self {
Self {
recursive: false,
options: DirOptions::new(),
}
}
/// Indicates that directories should be created recursively, creating all
/// parent directories.
///
/// This corresponds to [`std::fs::DirBuilder::recursive`].
#[inline]
pub fn recursive(&mut self, recursive: bool) -> &mut Self {
self.recursive = recursive;
self
}
/// Return the `DirOptions` contained in this `DirBuilder`.
#[inline]
pub const fn options(&self) -> &DirOptions {
&self.options
}
/// Return the value of the `recursive` flag.
#[inline]
pub const fn is_recursive(&self) -> bool {
self.recursive
}
}
#[cfg(unix)]
impl std::os::unix::fs::DirBuilderExt for DirBuilder {
#[inline]
fn mode(&mut self, mode: u32) -> &mut Self {
self.options.mode(mode);
self
}
}
impl fmt::Debug for DirBuilder {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let mut b = f.debug_struct("DirBuilder");
b.field("recursive", &self.recursive);
b.field("options", &self.options);
b.finish()
}
}