deprecate file_set_contents{,_full}

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

diff --git a/proxmox-tools/src/fs.rs b/proxmox-tools/src/fs.rs
index 9fd46cb5c30671e99f1ba15f96a9fc6e18b5e2e0..f5d389146367857115f44e375663f5e7f12932d4 100644 (file)
--- a/proxmox-tools/src/fs.rs
+++ b/proxmox-tools/src/fs.rs
@@ -75,43 +75,6 @@ pub fn replace_file<P: AsRef<Path>>(
     path: P,
     data: &[u8],
     options: CreateOptions,
-) -> Result<(), Error> {
-    file_set_contents_full(
-        path.as_ref(),
-        data,
-        options.perm,
-        options.owner,
-        options.group,
-    )
-}
-
-/// (To be deprecated) Atomically replace a file.
-///
-/// This first creates a temporary file and then rotates it in place.
-///
-/// FIXME: Mark as deprecated in favor of `replace_file`.
-/// Rationale:
-///   1) The name suggests that the contents of an existing file is changed.
-///   2) The function is split into this and a `_full` counterpart of which you need to remember
-///      the order of parameters. But we already introduced `CreateOptions` which can be used to
-///      provide a better API for both.
-///   3) `CreateOptions` is a builder, so more options can be added without having to change all
-///      its users!
-pub fn file_set_contents<P: AsRef<Path>>(
-    path: P,
-    data: &[u8],
-    perm: Option<stat::Mode>,
-) -> Result<(), Error> {
-    file_set_contents_full(path, data, perm, None, None)
-}
-
-/// Atomically write a file with owner and group
-pub fn file_set_contents_full<P: AsRef<Path>>(
-    path: P,
-    data: &[u8],
-    perm: Option<stat::Mode>,
-    owner: Option<Uid>,
-    group: Option<Gid>,
 ) -> Result<(), Error> {
     let path = path.as_ref();
 
@@ -128,17 +91,19 @@ pub fn file_set_contents_full<P: AsRef<Path>>(
 
     // clippy bug?: from_bits_truncate is actually a const fn...
     #[allow(clippy::or_fun_call)]
-    let mode: stat::Mode = perm.unwrap_or(stat::Mode::from_bits_truncate(0o644));
+    let mode: stat::Mode = options
+        .perm
+        .unwrap_or(stat::Mode::from_bits_truncate(0o644));
 
-    if perm != None {
+    if options.perm.is_some() {
         if let Err(err) = stat::fchmod(fd, mode) {
             let _ = unistd::unlink(tmp_path);
             bail!("fchmod {:?} failed: {}", tmp_path, err);
         }
     }
 
-    if owner != None || group != None {
-        if let Err(err) = fchown(fd, owner, group) {
+    if options.owner.is_some() || options.group.is_some() {
+        if let Err(err) = fchown(fd, options.owner, options.group) {
             let _ = unistd::unlink(tmp_path);
             bail!("fchown {:?} failed: {}", tmp_path, err);
         }
@@ -159,6 +124,49 @@ pub fn file_set_contents_full<P: AsRef<Path>>(
     Ok(())
 }
 
+/// Atomically replace a file.
+///
+/// This first creates a temporary file and then rotates it in place.
+///
+/// Deprecated for the following reasons:
+///   1) The name suggests that the contents of an existing file is changed.
+///   2) The function is split into this and a `_full` counterpart of which you need to remember
+///      the order of parameters. But we already introduced `CreateOptions` which can be used to
+///      provide a better API for both.
+///   3) `CreateOptions` is a builder, so more options can be added without having to change all
+///      its users!
+#[deprecated(note = "use replace_file instead")]
+pub fn file_set_contents<P: AsRef<Path>>(
+    path: P,
+    data: &[u8],
+    perm: Option<stat::Mode>,
+) -> Result<(), Error> {
+    #[allow(deprecated)]
+    file_set_contents_full(path.as_ref(), data, perm, None, None)
+}
+
+/// Atomically write a file with owner and group
+#[deprecated(note = "use replace_file instead")]
+pub fn file_set_contents_full<P: AsRef<Path>>(
+    path: P,
+    data: &[u8],
+    perm: Option<stat::Mode>,
+    owner: Option<Uid>,
+    group: Option<Gid>,
+) -> Result<(), Error> {
+    let mut options = CreateOptions::new();
+    if let Some(perm) = perm {
+        options = options.perm(perm);
+    }
+    if let Some(owner) = owner {
+        options = options.owner(owner);
+    }
+    if let Some(group) = group {
+        options = options.group(group);
+    }
+    replace_file(path.as_ref(), data, options)
+}
+
 /// Change ownership of an open file handle
 pub fn fchown(fd: RawFd, owner: Option<Uid>, group: Option<Gid>) -> Result<(), Error> {
     // According to the POSIX specification, -1 is used to indicate that owner and group