cdts/xdts-ios 3/Pods/DDWriteFileManager/WriteFileSupportSpec/Classes/DDWriteFileSupport.h

//
//  DDWriteFileSupport.h
//  ResultContained
//
//  Created by 李胜书 on 15/8/17.
//  Copyright (c) 2015年 李胜书. All rights reserved.
//

typedef enum {
    ///在documents下
    DDFieldDocuments = 0,
    ///在library/caches下
    DDFieldLibraryCaches,
    ///在temp下
    DDFieldTemp
}DDFileField;
typedef enum {
    ///需要返回image
    DDFileTypeImage = 0,
    ///需要返回数组
    DDFileTypeArray,
    ///需要返回字典
    DDFileTypeDictionary,
    ///需要返回文件流
    DDFileTypeData
}DDFileType;
typedef enum {
    ///需要返回kb大小
    DDSizeTypeKB = 0,
    ///需要返回mb大小
    DDSizeTypeMB,
    ///需要返回gb大小
    DDSizeTypeGB,
    ///需要返回tb大小
    DDSizeTypeTB
}DDSizeType;
typedef enum {
    ///图片为PNG
    DDImgTypePNG = 0,
    ///图片为JPEG
    DDImgTypeJPEG
}DDImgType;

#import <Foundation/Foundation.h>
#import <UIKit/UIKit.h>

@interface DDWriteFileSupport : NSObject

/**
 单实例化
 
 @return 返回生成的单实例
 */
+ (nonnull DDWriteFileSupport *)ShareInstance;

#pragma mark - ***** 获取路径 *****
/// 通过file存储时的url获取文件绝对路径，不存在则返回null
/// @param url 文件url
/// @param filed 文件存储位置DDFieldDocuments,DDFieldLibraryCaches,DDFieldTemp
- (nullable NSString *)searchFileByUrl:(nullable NSString *)url
                                 filed:(DDFileField)filed;
/// 通过file存储时的url和下载的文件夹名，获取文件绝对路径，不存在则返回null
/// @param url 文件url
/// @param cirName 文件夹name，如果有多重子文件夹都在这里一并传入,ps:test/donwload/down
/// @param filed 文件存储位置DDFieldDocuments,DDFieldLibraryCaches,DDFieldTemp
- (nullable NSString *)searchFileByUrl:(nullable NSString *)url
                               cirName:(nullable NSString *)cirName
                                 filed:(DDFileField)filed;
/// 通过file文件名获取文件绝对路径，不存在则返回null
/// @param name 文件name
/// @param filed 文件存储位置DDFieldDocuments,DDFieldLibraryCaches,DDFieldTemp
- (nullable NSString *)searchFileByFileName:(nullable NSString *)name
                                      filed:(DDFileField)filed;
/// 通过file文件名和下载的文件夹名，获取文件绝对路径，不存在则返回null
/// @param name 文件name
/// @param cirName 文件夹name，如果有多重子文件夹都在这里一并传入,ps:test/donwload/down
/// @param filed 文件存储位置DDFieldDocuments,DDFieldLibraryCaches,DDFieldTemp
- (nullable NSString *)searchFileByFileName:(nullable NSString *)name
                                    cirName:(nullable NSString *)cirName
                                      filed:(DDFileField)filed;
#pragma mark -  ***** 获取文件夹下子文件路径或文件名 *****
/**
 返回给定文件夹路径下所有文件或文件夹路径
 
 @param dirPath 给定的文件夹绝对路径
 @return 返回的文件列表数组，数组元素为子文件或子文件夹的绝对路径
 */
- (nullable NSMutableArray <NSString *> *)readDirPath:(nullable NSString *)dirPath;
/**
 读取文件夹下所有文件名。包含文件夹名，
 
 @param dirPath 给定的文件夹绝对路径
 @return 返回的文件列表数组，数组元素为自文件或自文件夹的名字
 */
- (nullable NSArray <NSString *> *)readDirNames:(nullable NSString *)dirPath;
#pragma mark - ***** 写入 *****
/**
 写入之前，如果要根据文件夹统一管理文件，则可调用此函数，根据filed参数创建文件夹
 
 @param dirName 文件夹名
 @param field 选择的field地址
 @return 返回创建结果
 */
- (BOOL)createDir:(nonnull NSString *)dirName
            filed:(DDFileField)field;
/**
 直接存储data流到本地指定路径，绝对路径为path，不管路径上是否已存在文件
 
 @param path 文件路径，需要为绝对路径
 @param data 二进制流，数组或字典，图片。图片默认为png格式，如果需要写jpg图片请使用选择图片type的方法
 @return 返回写入结果
 */
- (BOOL)directWriteFile:(nonnull NSString *)path
                   data:(nonnull id)data;
/**
 直接存储指定类型图片到本地指定路径，绝对路径为path，不管路径上是否已存在文件
 
 @param path 图片路径，需要为绝对路径
 @param img 图片
 @param imgType 图片类型
 @return 返回写入结果
 */
- (BOOL)directWriteFile:(nonnull NSString *)path
                    img:(nonnull UIImage *)img
              imageType:(DDImgType)imgType;
/**
 存储data流到本地，绝对路径为path，路径上如果已存在文件则返回写入失败
 
 @param path 文件路径，需要为绝对路径
 @param data 二进制流，数组或字典，图片，图片默认为png格式，如果需要写jpg图片请使用选择图片type的方法
 @return 返回写入结果
 */
- (BOOL)writeFile:(nonnull NSString *)path
             data:(nonnull id)data;
/**
 存储图片到本地，绝对路径为path，路径上如果已存在文件则返回写入失败
 
 @param path 文件路径，需要为绝对路径
 @param img 图片
 @param imgType 图片类型
 @return 返回写入结果
 */
- (BOOL)writeFile:(nonnull NSString *)path
              img:(nonnull UIImage *)img
        imageType:(DDImgType)imgType;
/**
 直接存储data流到本地doc,lib,temp中指定一处的相对位置，相对路径为path，不管路径上是否已存在文件，可通过参数选择三处位置
 
 @param path 文件相对路径，如果直接给文件名则直接写
 @param data 二进制流，数组或字典，图片，图片默认为png格式，如果需要写jpg图片请使用选择图片type的方法
 @param field 选择type
 @return 返回写入结果
 */
- (BOOL)directWriteFileType:(nonnull NSString *)path
                       data:(nonnull id)data
                      field:(DDFileField)field;
/**
 直接存储图片到本地doc,lib,temp中指定一处的相对位置，相对路径为path，不管路径上是否已存在文件，可通过参数选择三处位置
 
 @param path 文件相对路径，如果直接给文件名则直接写
 @param img 图片
 @param imgType 图片类型
 @param field 选择type
 @return 返回写入结果
 */
- (BOOL)directWriteFileType:(nonnull NSString *)path
                        img:(nonnull UIImage *)img
                  imageType:(DDImgType)imgType
                      field:(DDFileField)field;
/**
 存储data流到本地doc,lib,temp中指定一处的相对位置，相对路径为path，路径上已存在文件则返回失败，可通过参数选择三处位置
 
 @param path 文件相对路径，如果直接给文件名则直接写
 @param data 二进制流，数组或字典
 @param field 选择type
 @return 返回写入结果
 */
- (BOOL)writeFileType:(nonnull NSString *)path
                 data:(nonnull id)data
                field:(DDFileField)field;
/**
 存储图片到本地，相对路径为path，路径上已存在文件则返回失败，可通过参数选择三处位置
 
 @param path 文件相对路径，如果直接给文件名则直接写
 @param img 图片
 @param imgType 图片类型
 @param field 选择type
 @return 返回写入结果
 */
- (BOOL)writeFileType:(nonnull NSString *)path
                  img:(nonnull UIImage *)img
            imageType:(DDImgType)imgType
                field:(DDFileField)field;
#pragma mark - ***** 删除 *****
/**
 以绝对路径删除单个文件，如果不存在文件返回NO
 
 @param filePath 文件路径，绝对路径
 @return 删除结果
 */
- (BOOL)removeFile:(nonnull NSString *)filePath;
/**
 以绝对路径删除文件夹下所有子文件或文件夹，如果不存在文件夹返回NO
 
 @param dirPath 文件夹路径，绝对路径
 @return 删除结果
 */
- (BOOL)removeDirFiles:(nonnull NSString *)dirPath;
#pragma mark - 读取文件操作
/**
 读取绝对路径下的文件，不存在则返回nil，可选择直接返回的type,如果缓存中存在则直接返回不需要设置返回type
 
 @param filePath 文件绝对路径
 @param type 返回文件类型
 @return 返回文件
 */
- (nullable id)readFile:(nonnull NSString *)filePath
               fileType:(DDFileType)type;
/**
 读取filed相对路径下的文件，不存在则返回nil，可选择直接返回的type,如果缓存中存在则直接返回不需要设置返回type
 
 @param filePath 文件相对路径
 @param type 返回文件类型
 @param field 相对文件选址
 @return 返回文件
 */
- (nullable id)readFile:(nonnull NSString *)filePath
               fileType:(DDFileType)type
              fileField:(DDFileField)field;
/**
 删除nscache内的缓存
 */
- (void)flushCache;
#pragma mark - 计算文件或文件夹大小操作
/**
 通过绝对路径获取文件大小
 
 @param filePath 文件绝对路径
 @param type 返回文件大小的计算格式，kb,mb,gb,tb
 @return 返回文件大小
 */
- (float)countFileSize:(nullable NSString *)filePath
          fileSizeType:(DDSizeType)type;
/**
 通过相对路径获取文件大小
 
 @param filePath 文件相对路径
 @param field 文件选址
 @param type 返回文件大小的计算格式，kb,mb,gb,tb
 @return 返回文件大小
 */
- (float)countFileSize:(nullable NSString *)filePath
                 field:(DDFileField)field
          fileSizeType:(DDSizeType)type;
/**
 通过绝对路径获取文件夹大小
 
 @param dirPath 文件夹绝对路径
 @param type 返回文件大小的计算格式，kb,mb,gb,tb
 @return 返回文件夹大小
 */
- (float)countDirSize:(nullable NSString *)dirPath
         fileSizeType:(DDSizeType)type;
/**
 通过相对路径获取文件夹大小
 
 @param dirPath 文件夹相对路径
 @param field 文件夹选址
 @param type 返回文件夹大小的计算格式，kb,mb,gb,tb
 @return 返回文件夹大小
 */
- (float)countDirSize:(nullable NSString *)dirPath
                field:(DDFileField)field
         fileSizeType:(DDSizeType)type;

@end