LocalStorage Class Reference

A local file system. More...

Inheritance diagram for LocalStorage:

Public Member Functions
	LocalStorage (string root)
	Constructs a new instance of LocalStorage. More...
	LocalStorage (string root, string baseUrl)
	Constructs a new instance of LocalStorage. 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...
async 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...
async 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...

Detailed Description

A local file system.

Constructor & Destructor Documentation

LocalStorage() [1/2]

LocalStorage ( string  root )

inline

Constructs a new instance of LocalStorage.

Parameters

root	A path to the root of the file system.

LocalStorage() [2/2]

LocalStorage ( string  root, string  baseUrl  )

inline

Constructs a new instance of LocalStorage.

Parameters

root	A path to the root of the file system.
baseUrl	A base URL for accessing files over the network.

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]

async 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]

async 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.

---

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

• LocalStorage.cs