Interface IFileAccess

Namespace: SuperOffice.IO.Files
Assembly: SoCore.dll
Syntax
public interface IFileAccess

Properties

ArchivePath

Declaration
string ArchivePath { get; }
Property Value
Type Description
string

TemplatesPath

Declaration
string TemplatesPath { get; }
Property Value
Type Description
string

TemporaryPath

Declaration
string TemporaryPath { get; }
Property Value
Type Description
string

Methods

CreateDirectoryIfNotExists(string)

Declaration
void CreateDirectoryIfNotExists(string path)
Parameters
Type Name Description
string path

CreateForWriteAsync(string, CancellationToken)

Declaration
Task<Stream> CreateForWriteAsync(string path, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string path
CancellationToken cancellationToken
Returns
Type Description
Task<Stream>

DirectoryExists(string)

Declaration
bool DirectoryExists(string path)
Parameters
Type Name Description
string path
Returns
Type Description
bool

DirectoryGetFileInfosAsync(string, CancellationToken)

Declaration
Task<SoFileInfo[]> DirectoryGetFileInfosAsync(string path, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string path
CancellationToken cancellationToken
Returns
Type Description
Task<SoFileInfo[]>

DirectoryGetFilesAsync(string, string, bool, CancellationToken)

Declaration
Task<string[]> DirectoryGetFilesAsync(string path, string searchPattern, bool searchInSubdirectories = false, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string path
string searchPattern
bool searchInSubdirectories
CancellationToken cancellationToken
Returns
Type Description
Task<string[]>

EnsureAccess(Action)

Impersonation for Windows Disk File Access. For Azure File Access this is a noop.

Declaration
void EnsureAccess(Action action)
Parameters
Type Name Description
Action action

EnsureAccess(Func<Task>)

Impersonation for Windows Disk File Access. For Azure File Access this is a noop.

Declaration
Task EnsureAccess(Func<Task> func)
Parameters
Type Name Description
Func<Task> func
Returns
Type Description
Task

EnsureAccess<T>(Func<T>)

Impersonation for Windows Disk File Access. For Azure File Access this is a noop.

Declaration
T EnsureAccess<T>(Func<T> func)
Parameters
Type Name Description
Func<T> func
Returns
Type Description
T
Type Parameters
Name Description
T

FileDeleteAsync(string, CancellationToken)

Declaration
Task FileDeleteAsync(string path, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string path
CancellationToken cancellationToken
Returns
Type Description
Task

FileExistsAsync(string, CancellationToken)

Declaration
Task<bool> FileExistsAsync(string path, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string path
CancellationToken cancellationToken
Returns
Type Description
Task<bool>

GetDirectoryName(string)

Declaration
string GetDirectoryName(string path)
Parameters
Type Name Description
string path
Returns
Type Description
string

GetFileName(string)

Declaration
string GetFileName(string path)
Parameters
Type Name Description
string path
Returns
Type Description
string

GetFileNameWithoutExtension(string)

Declaration
string GetFileNameWithoutExtension(string path)
Parameters
Type Name Description
string path
Returns
Type Description
string

OpenReadOnlyNoLockAsync(string, CancellationToken)

Open a file/blob for reading

Declaration
Task<Stream> OpenReadOnlyNoLockAsync(string path, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string path
CancellationToken cancellationToken
Returns
Type Description
Task<Stream>
Remarks

Will call System.IO.File.Open() or Azure.Storage.Blobs.BlobClient.OpenRead()

Exceptions
Type Condition
SoFileNotFoundException

Wraps System.IO.FileNotFoundException and Azure.RequestFailedException when Status is 404. Check for SoFileNotFoundException instead of doing FileExists before call to this method.

PathCombine(params string[])

Declaration
string PathCombine(params string[] paths)
Parameters
Type Name Description
string[] paths
Returns
Type Description
string

PathGetExtension(string)

Declaration
string PathGetExtension(string path)
Parameters
Type Name Description
string path
Returns
Type Description
string

PathGetFileName(string)

Declaration
string PathGetFileName(string path)
Parameters
Type Name Description
string path
Returns
Type Description
string

PathGetInvalidFileNameChars()

Declaration
char[] PathGetInvalidFileNameChars()
Returns
Type Description
char[]

SaveStreamToFileAsync(Stream, string, CancellationToken)

Save a stream to file/blob

Declaration
Task SaveStreamToFileAsync(Stream stream, string path, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Stream stream
string path
CancellationToken cancellationToken
Returns
Type Description
Task
Remarks

Will call System.IO.File.Create() or Azure.Storage.Blobs.BlobClient.Upload(), both implementations will overwrite any existing file/blob.

Extension Methods