Added TryRenameItemAsync and TryDeleteItemAsync to IFileStorageHelper

Author: shweaver-MSFT

Microsoft.Toolkit.Uwp/Helpers/ObjectStorage/ApplicationDataStorageHelper.CacheFolder.cs

@@ -29,7 +29,7 @@ public partial class ApplicationDataStorageHelper
         /// <returns>Waiting task until completion with the object in the file.</returns>
         public Task<T> ReadCacheFileAsync<T>(string filePath, T @default = default)
         {
-            return ReadFileAsync<T>(CacheFolder, filePath, @default);
+            return ReadFileAsync<T>(this.CacheFolder, filePath, @default);
         }
 
         /// <summary>
@@ -39,7 +39,7 @@ public Task<T> ReadCacheFileAsync<T>(string filePath, T @default = default)
         /// <returns>A list of file types and names in the target folder.</returns>
         public Task<IEnumerable<(DirectoryItemType ItemType, string Name)>> ReadCacheFolderAsync(string folderPath)
         {
-            return ReadFolderAsync(CacheFolder, folderPath);
+            return ReadFolderAsync(this.CacheFolder, folderPath);
         }
 
         /// <summary>
@@ -51,7 +51,7 @@ public Task<T> ReadCacheFileAsync<T>(string filePath, T @default = default)
         /// <returns>Waiting task until completion.</returns>
         public Task CreateCacheFileAsync<T>(string filePath, T value)
         {
-            return SaveFileAsync<T>(CacheFolder, filePath, value);
+            return CreateFileAsync<T>(this.CacheFolder, filePath, value);
         }
 
         /// <summary>
@@ -61,17 +61,28 @@ public Task CreateCacheFileAsync<T>(string filePath, T value)
         /// <returns>Waiting task until completion.</returns>
         public Task CreateCacheFolderAsync(string folderPath)
         {
-            return CreateFolderAsync(CacheFolder, folderPath);
+            return CreateFolderAsync(this.CacheFolder, folderPath);
         }
 
         /// <summary>
         /// Deletes a file or folder item in the LocalCacheFolder.
         /// </summary>
         /// <param name="itemPath">The path to the item for deletion.</param>
         /// <returns>Waiting task until completion.</returns>
-        public Task DeleteCacheItemAsync(string itemPath)
+        public Task<bool> TryDeleteCacheItemAsync(string itemPath)
         {
-            return DeleteItemAsync(CacheFolder, itemPath);
+            return TryDeleteItemAsync(CacheFolder, itemPath);
+        }
+
+        /// <summary>
+        /// Rename an item in the LocalCacheFolder.
+        /// </summary>
+        /// <param name="itemPath">The path to the target item.</param>
+        /// <param name="newName">The new nam for the target item.</param>
+        /// <returns>Waiting task until completion.</returns>
+        public Task<bool> TryRenameCacheItemAsync(string itemPath, string newName)
+        {
+            return TryRenameItemAsync(this.CacheFolder, itemPath, newName);
         }
     }
 }

Microsoft.Toolkit.Uwp/Helpers/ObjectStorage/ApplicationDataStorageHelper.cs

@@ -259,7 +259,7 @@ public bool TryDelete(string compositeKey, string key)
         /// <inheritdoc />
         public Task CreateFileAsync<T>(string filePath, T value)
         {
-            return this.SaveFileAsync<T>(this.Folder, filePath, value);
+            return this.CreateFileAsync<T>(this.Folder, filePath, value);
         }
 
         /// <inheritdoc />
@@ -269,21 +269,15 @@ public Task CreateFolderAsync(string folderPath)
         }
 
         /// <inheritdoc />
-        public Task DeleteItemAsync(string itemPath)
+        public Task<bool> TryDeleteItemAsync(string itemPath)
         {
-            return this.DeleteItemAsync(this.Folder, itemPath);
+            return TryDeleteItemAsync(this.Folder, itemPath);
         }
 
-        /// <summary>
-        /// Saves an object inside a file.
-        /// </summary>
-        /// <typeparam name="T">Type of object saved.</typeparam>
-        /// <param name="filePath">Path to the file that will contain the object.</param>
-        /// <param name="value">Object to save.</param>
-        /// <returns>Waiting task until completion.</returns>
-        public Task<StorageFile> SaveFileAsync<T>(string filePath, T value)
+        /// <inheritdoc />
+        public Task<bool> TryRenameItemAsync(string itemPath, string newName)
         {
-            return this.SaveFileAsync(this.Folder, filePath, value);
+            return TryRenameItemAsync(this.Folder, itemPath, newName);
         }
 
         private async Task<T?> ReadFileAsync<T>(StorageFolder folder, string filePath, T? @default = default)
@@ -307,7 +301,7 @@ public Task<StorageFile> SaveFileAsync<T>(string filePath, T value)
             });
         }
 
-        private Task<StorageFile> SaveFileAsync<T>(StorageFolder folder, string filePath, T value)
+        private Task<StorageFile> CreateFileAsync<T>(StorageFolder folder, string filePath, T value)
         {
             return StorageFileHelper.WriteTextToFileAsync(folder, this.Serializer.Serialize(value)?.ToString(), filePath, CreationCollisionOption.ReplaceExisting);
         }
@@ -317,10 +311,32 @@ private async Task CreateFolderAsync(StorageFolder folder, string folderPath)
             await folder.CreateFolderAsync(folderPath, CreationCollisionOption.OpenIfExists);
         }
 
-        private async Task DeleteItemAsync(StorageFolder folder, string itemPath)
+        private async Task<bool> TryDeleteItemAsync(StorageFolder folder, string itemPath)
         {
-            var item = await folder.GetItemAsync(itemPath);
-            await item.DeleteAsync();
+            try
+            {
+                var item = await folder.GetItemAsync(itemPath);
+                await item.DeleteAsync();
+                return true;
+            }
+            catch
+            {
+                return false;
+            }
+        }
+
+        private async Task<bool> TryRenameItemAsync(StorageFolder folder, string itemPath, string newName)
+        {
+            try
+            {
+                var item = await folder.GetItemAsync(itemPath);
+                await item.RenameAsync(newName, NameCollisionOption.FailIfExists);
+                return true;
+            }
+            catch
+            {
+                return false;
+            }
         }
     }
 }

Microsoft.Toolkit/Helpers/ObjectStorage/IFileStorageHelper.cs

@@ -55,6 +55,14 @@ public interface IFileStorageHelper
         /// </summary>
         /// <param name="itemPath">The path to the item for deletion.</param>
         /// <returns>Waiting task until completion.</returns>
-        Task DeleteItemAsync(string itemPath);
+        Task<bool> TryDeleteItemAsync(string itemPath);
+
+        /// <summary>
+        /// Rename an item.
+        /// </summary>
+        /// <param name="itemPath">The path to the target item.</param>
+        /// <param name="newName">The new nam for the target item.</param>
+        /// <returns>Waiting task until completion.</returns>
+        Task<bool> TryRenameItemAsync(string itemPath, string newName);
     }
 }