FileReading Protocol Reference


                    
                    
                    searchFile(with:atDirectory:)

Extension method

Search file at a given directory or at FileStorageManageable.directoryURL, with given remote location of file url.

Will search including all subdirectories.

Throws

FileStorageError.invalidPath, FileStorageError.invalidFileNameOrExtentision, FileStorageError.fileNotFound

Declaration

Swift

func searchFile(with url: URL, atDirectory directortyURL: URL? = nil) throws -> URL

Parameters

`url`	File’s remote location url.
`directortyURL`	Search directory, if nil, `FileStorageManageable.directoryURL` will be used instead.

Return Value

File’s storage location


                    
                    
                    searchFile(withFilename:fileExtention:directortyURL:)

Extension method

Search file at a given directory or at FileStorageManageable.directoryURL, with given filename and file extension.

Declaration

Swift

func searchFile(withFilename filename: String, fileExtention: String? = nil, directortyURL: URL? = nil) throws -> [URL]

Parameters

`filename`	Filename.
`fileExtention`	File extension.
`directortyURL`	directory `URL`.


                    
                    
                    fileData(at:atDirectory:)

Extension method

Search file at a given directory or at FileStorageManageable.directoryURL, with given remote location of file url.

Will search including all subdirectories.

Throws

FileStorageError.invalidPath, FileStorageError.invalidFileNameOrExtentision, FileStorageError.fileNotFound

Declaration

Swift

func fileData(at url: URL, atDirectory directortyURL: URL? = nil) throws -> Data?

Parameters

`url`	File’s remote location `URL`.
`directortyURL`	Search directory, if nil, `FileStorageManageable.directoryURL` will be used instead.

Return Value

Data representation of a file


                    
                    
                    fileData(_:)

Extension method

Returns Data form given local file location

Declaration

Swift

func fileData(_ url: URL) -> Data?

Parameters

url

Local file location


                    
                    
                    filespec(at:atDirectory:)

Extension method

Search filespec object at a given directory or at FileStorageManageable.directoryURL, with given remote location of file url.

Will search including all subdirectories.

Throws

FileStorageError.invalidPath, FileStorageError.invalidFileNameOrExtentision, FileStorageError.fileNotFound

Declaration

Swift

func filespec(at url: URL, atDirectory directortyURL: URL? = nil) throws -> Filespec?

Parameters

`url`	File’s remote location `URL`.
`directortyURL`	Search directory, if nil, `FileStorageManageable.directoryURL` will be used instead.

Return Value

Filespec object


                    
                    
                    filespec(withFilename:atDirectory:)

Extension method

Search filespec object at a given directory or at FileStorageManageable.directoryURL, with given filename and file extension.

Declaration

Swift

func filespec(withFilename filename: String, atDirectory directortyURL: URL? = nil) throws -> Filespec?

Parameters

`filename`	Filename.
`fileExtension`	File extension.
`directortyURL`	Directory `URL`.


                    
                    
                    filespecs(atDirectory:)

Extension method

Returs list of filespepcs

Declaration

Swift

func filespecs(atDirectory directortyURL: URL? = nil) throws -> [Filespec]

Parameters


                                directortyURL

Directory.


                    
                    
                    directories(atDirectory:)

Extension method

List of directories at a given directory or at FileStorageManageable.directoryURL.

Throws

FileStorageError.invalidPath.

Declaration

Swift

func directories(atDirectory directortyURL: URL? = nil) throws -> [URL]

Parameters


                                directortyURL

Search directory, if nil, FileStorageManageable.directoryURL will be used instead.

Return Value

List of directories as Array of URL.


                    
                    
                    directoriesName(atDirectory:)

Extension method

List of directories name at a given directory or at FileStorageManageable.directoryURL.

Throws

FileStorageError.invalidPath.

Declaration

Swift

func directoriesName(atDirectory directortyURL: URL? = nil) -> [String]

Parameters


                                directortyURL

Search directory, if nil, FileStorageManageable.directoryURL will be used instead.

Return Value

List of directories lastPathComponent, as Array of String.


                    
                    
                    filesIn(enumerateDirectories:includeDirectories:atDirectory:)

Extension method

List of files at a given directory or at FileStorageManageable.directoryURL.

Throws

FileStorageError.invalidPath.

Declaration

Swift

func filesIn(enumerateDirectories: Bool = true, includeDirectories: Bool = false, atDirectory directortyURL: URL? = nil) throws -> [URL]

Parameters

`enumerateDirectories`	Whether subdirectories and their files should be included.
`includeDirectories`	Whether directories should be also returned.
`directortyURL`	Search directory, if nil, `FileStorageManageable.directoryURL` will be used instead.

Return Value

List of directories lastPathComponent, as Array of String.