A FTP file system. More...

Inheritance diagram for FtpStorage:

Public Member Functions
	FtpStorage (string host, string port, string userName, string password, string root, string ftpEncryption)
	Constructs a new instance of FtpStorage. More...

	FtpStorage (string host, string port, string userName, string password, string root)
	Constructs a new instance of FtpStorage. More...

async Task	CreateFolderAsync (string path, CancellationToken cancellationToken)
	Asynchronously creates new folder. More...

async Task	DeleteFileAsync (string path, CancellationToken cancellationToken)
	Asynchronously deletes a file. More...

async Task	DeleteFolderAsync (string path, CancellationToken cancellationToken)
	Asynchronously deletes a folder. More...

async Task	DeleteFolderAsync (string path, Action< int, int > progressAction, CancellationToken cancellationToken)
	Asynchronously deletes a folder. More...

async Task	MoveFileAsync (string srcPath, string destPath, CancellationToken cancellationToken)
	Asynchronously moves a file. More...

async Task	MoveFolderAsync (string srcPath, string destPath, CancellationToken cancellationToken)
	Asynchronously moves a folder. More...

async Task	MoveFolderAsync (string srcPath, string destPath, Action< int, int > progressAction, CancellationToken cancellationToken)
	Asynchronously moves a folder. More...

async Task	CopyFileAsync (string srcPath, string destPath, CancellationToken cancellationToken)
	Asynchronously copies a file. More...

async Task< bool >	FileExistsAsync (string path, CancellationToken cancellationToken)
	Asynchronously checks whether a file exists. More...

async Task< bool >	FolderExistsAsync (string path, CancellationToken cancellationToken)
	Asynchronously checks whether a folder exists. More...

async Task	WriteAsync (Stream fileStream, string path, CancellationToken cancellationToken)
	Asynchronously writes file content. More...

async Task< Stream >	ReadAsync (string path, CancellationToken cancellationToken)
	Asynchronously reads file content. More...

async Task< FolderListResult >	GetFolderInfosAsync (string path, CancellationToken cancellationToken)
	Asynchronously lists folder informations. More...

Task< FolderListResult >	GetFolderInfosAsync (IFolderListContinuation folderListContinuation, CancellationToken cancellationToken)
	Asynchronously lists folder informations. More...

async Task< FileListResult >	GetFileInfosAsync (string path, CancellationToken cancellationToken)
	Asynchronously lists file informations. More...

Task< FileListResult >	GetFileInfosAsync (IFileListContinuation fileListContinuation, CancellationToken cancellationToken)
	Asynchronously lists file informations. More...

async Task< FolderInfo >	GetFolderInfoAsync (string path, CancellationToken cancellationToken)
	Asychronously gets folder information. More...

async Task< FileInfo >	GetFileInfoAsync (string path, CancellationToken cancellationToken)
	Asychronously gets file information. More...

Task< string >	GetUrlAsync (string path, CancellationToken cancellationToken)
	Asynchronously gets resource URL. May return null if URL is not available. More...

Properties
Action< FtpClient >	OnConnect `[get, set]`
	Gets or sets the action executed when a connection to the FTP server is about to happen. More...

Detailed Description

A FTP file system.

Constructor & Destructor Documentation

◆ FtpStorage() [1/2]

FtpStorage	(	string	host,
		string	port,
		string	userName,
		string	password,
		string	root,
		string	ftpEncryption
	)

inline

Constructs a new instance of FtpStorage.

Parameters

host	A host to connect to.
port	A port number to connect to.
userName	A user name.
password	An account password.
root	A root folder on the FTP server.
ftpEncryption	An encryption mode to use. Valid values are: none, ssl, tls.

◆ FtpStorage() [2/2]

FtpStorage	(	string	host,
		string	port,
		string	userName,
		string	password,
		string	root
	)

inline

Constructs a new instance of FtpStorage.

Parameters

host	A host to connect to.
port	A port number to connect to.
userName	A user name.
password	An account password.
root	A root folder on the FTP server.

Member Function Documentation

◆ CopyFileAsync()

async Task CopyFileAsync	(	string	srcPath,
		string	destPath,
		CancellationToken	cancellationToken
	)

inline

Asynchronously copies a file.

Parameters

srcPath	A path to the file.
destPath	A path to the destination file.
cancellationToken	A cancellation token.

Implements IFileSystem.

◆ CreateFolderAsync()

async Task CreateFolderAsync	(	string	path,
		CancellationToken	cancellationToken
	)

inline

Asynchronously creates new folder.

Parameters

path	A path to the new folder.
cancellationToken	A cancellation token.

Implements IFileSystem.

◆ DeleteFileAsync()

async Task DeleteFileAsync	(	string	path,
		CancellationToken	cancellationToken
	)

inline

Asynchronously deletes a file.

Parameters

path	A path to the file.
cancellationToken	A cancellation token.

Implements IFileSystem.

◆ DeleteFolderAsync() [1/2]

async Task DeleteFolderAsync	(	string	path,
		Action< int, int >	progressAction,
		CancellationToken	cancellationToken
	)

inline

Asynchronously deletes a folder.

Parameters

path	A path to the folder.
progressAction	An action fired when progress is updated.
cancellationToken	A cancellation token.

Implements IFileSystem.

◆ DeleteFolderAsync() [2/2]

async Task DeleteFolderAsync	(	string	path,
		CancellationToken	cancellationToken
	)

inline

Asynchronously deletes a folder.

Parameters

path	A path to the folder.
cancellationToken	A cancellation token.

Implements IFileSystem.

◆ FileExistsAsync()

async Task<bool> FileExistsAsync	(	string	path,
		CancellationToken	cancellationToken
	)

inline

Asynchronously checks whether a file exists.

Parameters

path	A path to the file.
cancellationToken	A cancellation token.

Returns: True if file exists, false otherwise.

Implements IFileSystem.

◆ FolderExistsAsync()

async Task<bool> FolderExistsAsync	(	string	path,
		CancellationToken	cancellationToken
	)

inline

Asynchronously checks whether a folder exists.

Parameters

path	A path to the folder.
cancellationToken	A cancellation token.

Returns: True if folder exists, false otherwise.

Implements IFileSystem.

◆ GetFileInfoAsync()

async Task<FileInfo> GetFileInfoAsync	(	string	path,
		CancellationToken	cancellationToken
	)

inline

Asychronously gets file information.

Parameters

path	A path to the file.
cancellationToken	A cancellation token.

Returns: A file information.

Implements IFileSystem.

◆ GetFileInfosAsync() [1/2]

Task<FileListResult> GetFileInfosAsync	(	IFileListContinuation	fileListContinuation,
		CancellationToken	cancellationToken
	)

inline

Asynchronously lists file informations.

Parameters

fileListContinuation	A file list continuation.
cancellationToken	A cancellation token.

Returns: A file list result.

Implements IFileSystem.

◆ GetFileInfosAsync() [2/2]

async Task<FileListResult> GetFileInfosAsync	(	string	path,
		CancellationToken	cancellationToken
	)

inline

Asynchronously lists file informations.

Parameters

path	A path to the folder.
cancellationToken	A cancellation token.

Returns: A file list result.

Implements IFileSystem.

◆ GetFolderInfoAsync()

async Task<FolderInfo> GetFolderInfoAsync	(	string	path,
		CancellationToken	cancellationToken
	)

inline

Asychronously gets folder information.

Parameters

path	A path to the folder.
cancellationToken	A cancellation token.

Returns: A folder information.

Implements IFileSystem.

◆ GetFolderInfosAsync() [1/2]

Task<FolderListResult> GetFolderInfosAsync	(	IFolderListContinuation	folderListContinuation,
		CancellationToken	cancellationToken
	)

inline

Asynchronously lists folder informations.

Parameters

folderListContinuation	A folder list continuation.
cancellationToken	A cancellation token.

Returns: A folder list result.

Implements IFileSystem.

◆ GetFolderInfosAsync() [2/2]

async Task<FolderListResult> GetFolderInfosAsync	(	string	path,
		CancellationToken	cancellationToken
	)

inline

Asynchronously lists folder informations.

Parameters

path	A path to the folder.
cancellationToken	A cancellation token.

Returns: A folder list result.

Implements IFileSystem.

◆ GetUrlAsync()

Task<string> GetUrlAsync	(	string	path,
		CancellationToken	cancellationToken
	)

inline

Asynchronously gets resource URL. May return null if URL is not available.

Parameters

path	A path to the resource.
cancellationToken	A cancellation token.

Returns: An URL to the resource or null if URL is not available.

Implements IFileSystem.

◆ MoveFileAsync()

async Task MoveFileAsync	(	string	srcPath,
		string	destPath,
		CancellationToken	cancellationToken
	)

inline

Asynchronously moves a file.

Parameters

srcPath	A path to the file.
destPath	A path to the destination file.
cancellationToken	A cancellation token.

Implements IFileSystem.

◆ MoveFolderAsync() [1/2]

async Task MoveFolderAsync	(	string	srcPath,
		string	destPath,
		Action< int, int >	progressAction,
		CancellationToken	cancellationToken
	)

inline

Asynchronously moves a folder.

Parameters

srcPath	A path to the folder.
destPath	A path to the destination folder.
progressAction	An action fired when progress is updated.
cancellationToken	A cancellation token.

Implements IFileSystem.

◆ MoveFolderAsync() [2/2]

async Task MoveFolderAsync	(	string	srcPath,
		string	destPath,
		CancellationToken	cancellationToken
	)

inline

Asynchronously moves a folder.

Parameters

srcPath	A path to the folder.
destPath	A path to the destination folder.
cancellationToken	A cancellation token.

Implements IFileSystem.

◆ ReadAsync()

async Task<Stream> ReadAsync	(	string	path,
		CancellationToken	cancellationToken
	)

inline

Asynchronously reads file content.

Parameters

path	A path to the file.
cancellationToken	A cancellation token.

Returns: A stream with file content.

Implements IFileSystem.

◆ WriteAsync()

async Task WriteAsync	(	Stream	fileStream,
		string	path,
		CancellationToken	cancellationToken
	)

inline

Asynchronously writes file content.

Parameters

fileStream	A stream with content to write.
path	A path to the file.
cancellationToken	A cancellation token.

Implements IFileSystem.

Property Documentation

◆ OnConnect

Action<FtpClient> OnConnect

getset

Gets or sets the action executed when a connection to the FTP server is about to happen.

The documentation for this class was generated from the following file:

FtpStorage.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ FtpStorage() [1/2]

◆ FtpStorage() [2/2]

Member Function Documentation

◆ CopyFileAsync()

◆ CreateFolderAsync()

◆ DeleteFileAsync()

◆ DeleteFolderAsync() [1/2]

◆ DeleteFolderAsync() [2/2]

◆ FileExistsAsync()

◆ FolderExistsAsync()

◆ GetFileInfoAsync()

◆ GetFileInfosAsync() [1/2]

◆ GetFileInfosAsync() [2/2]

◆ GetFolderInfoAsync()

◆ GetFolderInfosAsync() [1/2]

◆ GetFolderInfosAsync() [2/2]

◆ GetUrlAsync()

◆ MoveFileAsync()

◆ MoveFolderAsync() [1/2]

◆ MoveFolderAsync() [2/2]

◆ ReadAsync()

◆ WriteAsync()

Property Documentation

◆ OnConnect