Explorer Class Reference


                    
                    
                    default

Singleton of Explorer Class

Declaration

Swift

public static let `default`: Explorer


                    
                    
                    init(with:)

Undocumented

Declaration

Swift

public init(with fileManager: FileProvider = DefaultFileProvider())


                    
                    
                    currentDirectoryPath

Undocumented

Declaration

Swift

public var currentDirectoryPath: String { get }


                    
                    
                    delete(operation:)

Delete File

Declaration

Swift

@discardableResult
public func delete(operation: SingleFileOperation) -> Result<SingleFileOperation, Error>

Parameters


                                operation

Delete operation, will delete spesific file at spesific path with SingleFileOperation

Return Value

Result Result<SingleFileOperation, Error> of the operation.


                    
                    
                    delete(operation:)

Delete Folder

Declaration

Swift

@discardableResult
public func delete(operation: SingleFolderOperation) -> Result<SingleFolderOperation, Error>

Parameters


                                operation

Delete operation, will delete spesific folder at spesific path.

Return Value

Result Result<SingleFileOperation, Error> of the operation.


                    
                    
                    write(operation:writingStrategy:)

Write file

Declaration

Swift

@discardableResult
public func write(operation: SingleFileOperation, writingStrategy: WriteStrategy = .safe) -> Result<SingleFileOperation, Error>

Parameters

`operation`	Write Operation, will write spesific to the operation
`writingStrategy`	how you want the operation to write based on spesific strategy
`currentProgressCallback`	add your custom action in the middle of the operation (for example, you want to print the current progress operation)

Return Value

Result of the operation.


                    
                    
                    write(operation:writingStrategy:)

Write files

Declaration

Swift

@discardableResult
public func write(operation: BatchFileOperation, writingStrategy: WriteStrategy = .safe) -> Result<BatchFileOperation, Error>

Parameters

`operation`	Write Operation, will write spesific to the operation
`writingStrategy`	how you want the operation to write based on spesific strategy
`currentProgressCallback`	add your custom action in the middle of the operation (for example, you want to print the current progress operation)

Return Value

Result of the operation.


                    
                    
                    write(operation:writingStrategy:)

Write Folder, define your folder and files, and Explorer will create for you.

Declaration

Swift

@discardableResult
public func write(operation: SingleFolderOperation, writingStrategy: WriteStrategy = .safe) -> Result<SingleFolderOperation, Error>

Parameters

`operation`	Write Operation, will write spesific to the operation
`writingStrategy`	how you want the operation to write based on spesific strategy
`currentProgressCallback`	add your custom action in the middle of the operation (for example, you want to print the current progress operation)

Return Value

Result of the operation.


                    
                    
                    write(operation:writingStrategy:)

Write Folder, define your folder and files, and Explorer will create for you.

Declaration

Swift

@discardableResult
public func write(operation: BatchFolderOperation, writingStrategy: WriteStrategy = .safe) -> Result<BatchFolderOperation, Error>

Parameters

`operation`	Write Operation, will write spesific to the operation
`writingStrategy`	how you want the operation to write based on spesific strategy
`currentProgressCallback`	add your custom action in the middle of the operation (for example, you want to print the current progress operation)

Return Value

Result of the operation.


                    
                    
                    isFileExist(path:)

Check if current path is exist or not

Declaration

Swift

public func isFileExist(path: String) -> Bool


                    
                    
                    isFile(path:)

Check if current path is file or directory

Declaration

Swift

public func isFile(path: String) -> Result<Bool, Error>


                    
                    
                    list(at:withFolder:isRecursive:)

Scan directory at path, will return the content inside it

Declaration

Swift

public func list(at path: String, withFolder isFolderIncluded: Bool, isRecursive: Bool) -> Result<[Explorable], Error>

Parameters

`path`	Path to scan
`withFolder`	Also Scan folder or not
`isRecursive`	will include content inside folder

Return Value

Result of Explorables