Class LocalDiskStorage

Local disk file storage implementation.

Inheritance

System.Object

StorageBase

LocalDiskStorage

Implements

IStorage

Inherited Members

StorageBase.DefaultTextEncodingName

StorageBase.textEncoding

StorageBase.useMetaData

StorageBase.useCatalog

StorageBase.TextEncoding

StorageBase.UseMetaData

StorageBase.UseCatalog

StorageBase.BackupSuffix

StorageBase.MetaSuffix

StorageBase.CatalogIdentifier

StorageBase.CommitWriteStream(IStorageStream)

StorageBase.WriteAllText(String, String)

StorageBase.WriteAllBytes(String, Byte[])

StorageBase.Delete(String)

StorageBase.Move(String, String, Boolean)

StorageBase.Copy(String, String, Boolean)

StorageBase.UpdateMetaData(String, Boolean, Boolean)

StorageBase.SaveMetaData(String, StorageMetaData)

StorageBase.LoadMetaData(String)

StorageBase.DeleteMetaData(String)

StorageBase.HasMetaData(String)

StorageBase.GetMetaIdentifier(String)

StorageBase.IsMetaIdentifier(String)

StorageBase.SaveCatalog(List<String>)

StorageBase.LoadCatalog()

StorageBase.AddToCatalog(String)

StorageBase.RemoveFromCatalog(String)

StorageBase.RenameInCatalog(String, String)

StorageBase.IsCatalogIdentifier(String)

StorageBase.CreateBackup(String)

StorageBase.RestoreLatestBackup(String)

StorageBase.GetLatestBackup(String)

StorageBase.RestoreBackup(String, StorageBackup)

StorageBase.GetBackups(String)

StorageBase.DeleteBackup(String, StorageBackup)

StorageBase.DeleteBackups(String)

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Bayat.SaveSystem.Storage

Assembly: Bayat.SaveSystem.Runtime.dll

Syntax

public class LocalDiskStorage : StorageBase, IStorage

Constructors

LocalDiskStorage(String)

Declaration

public LocalDiskStorage(string basePath)

Parameters

Type	Name	Description
System.String	basePath

Fields

basePath

Declaration

protected string basePath

Field Value

Type	Description
System.String

Properties

BasePath

The base path.

Declaration

public virtual string BasePath { get; set; }

Property Value

Type	Description
System.String

TemporarySuffix

Declaration

public virtual string TemporarySuffix { get; }

Property Value

Type	Description
System.String

Methods

Clear()

Declaration

public override async Task<StorageClearOperationResult> Clear()

Returns

Type	Description
System.Threading.Tasks.Task<StorageClearOperationResult>

Overrides

StorageBase.Clear()

CommitWriteStreamInternal(IStorageStream)

Declaration

protected override Task CommitWriteStreamInternal(IStorageStream stream)

Parameters

Type	Name	Description
IStorageStream	stream

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

StorageBase.CommitWriteStreamInternal(IStorageStream)

CopyInternal(String, String, Boolean)

Declaration

protected override async Task<StorageCopyOperationResult> CopyInternal(string fromIdentifier, string toIdentifier, bool replace)

Parameters

Type	Name	Description
System.String	fromIdentifier
System.String	toIdentifier
System.Boolean	replace

Returns

Type	Description
System.Threading.Tasks.Task<StorageCopyOperationResult>

Overrides

StorageBase.CopyInternal(String, String, Boolean)

DeleteInternal(String)

Declaration

protected override Task<StorageDeleteOperationResult> DeleteInternal(string identifier)

Parameters

Type	Name	Description
System.String	identifier

Returns

Type	Description
System.Threading.Tasks.Task<StorageDeleteOperationResult>

Overrides

StorageBase.DeleteInternal(String)

Exists(String)

Declaration

public override Task<bool> Exists(string identifier)

Parameters

Type	Name	Description
System.String	identifier

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

Overrides

StorageBase.Exists(String)

GetAbsolutePath(String)

Gets the absolute path for the specified identifier using the base path.

Declaration

public virtual string GetAbsolutePath(string identifier)

Parameters

Type	Name	Description
System.String	identifier	The item identifier

Returns

Type	Description
System.String	The absolute path to the file

GetReadStream(String)

Declaration

public override Task<IStorageStream> GetReadStream(string identifier)

Parameters

Type	Name	Description
System.String	identifier

Returns

Type	Description
System.Threading.Tasks.Task<IStorageStream>

Overrides

StorageBase.GetReadStream(String)

GetRelativePath(String, String)

Creates a relative path from one file or folder to another.

Declaration

public static string GetRelativePath(string fromPath, string toPath)

Parameters

Type	Name	Description
System.String	fromPath	Contains the directory that defines the start of the relative path.
System.String	toPath	Contains the path that defines the endpoint of the relative path.

Returns

Type	Description
System.String	The relative path from the start directory to the end path or toPath if the paths are not related.

Exceptions

Type	Condition
System.ArgumentNullException
System.UriFormatException
System.InvalidOperationException

GetWriteStream(String)

Declaration

public override Task<IStorageStream> GetWriteStream(string identifier)

Parameters

Type	Name	Description
System.String	identifier

Returns

Type	Description
System.Threading.Tasks.Task<IStorageStream>

Overrides

StorageBase.GetWriteStream(String)

List(String, StorageListOptions)

Declaration

public override Task<string[]> List(string identifier, StorageListOptions options)

Parameters

Type	Name	Description
System.String	identifier
StorageListOptions	options

Returns

Type	Description
System.Threading.Tasks.Task<System.String[]>

Overrides

StorageBase.List(String, StorageListOptions)

ListAll()

Declaration

public override Task<string[]> ListAll()

Returns

Type	Description
System.Threading.Tasks.Task<System.String[]>

Overrides

StorageBase.ListAll()

MoveInternal(String, String, Boolean)

Declaration

protected override async Task<StorageMoveOperationResult> MoveInternal(string oldIdentifier, string newIdentifier, bool replace)

Parameters

Type	Name	Description
System.String	oldIdentifier
System.String	newIdentifier
System.Boolean	replace

Returns

Type	Description
System.Threading.Tasks.Task<StorageMoveOperationResult>

Overrides

StorageBase.MoveInternal(String, String, Boolean)

ReadAllBytes(String)

Declaration

public override Task<byte[]> ReadAllBytes(string identifier)

Parameters

Type	Name	Description
System.String	identifier

Returns

Type	Description
System.Threading.Tasks.Task<System.Byte[]>

Overrides

StorageBase.ReadAllBytes(String)

ReadAllText(String)

Declaration

public override Task<string> ReadAllText(string identifier)

Parameters

Type	Name	Description
System.String	identifier

Returns

Type	Description
System.Threading.Tasks.Task<System.String>

Overrides

StorageBase.ReadAllText(String)

WriteAllBytesInternal(String, Byte[])

Declaration

protected override Task WriteAllBytesInternal(string identifier, byte[] data)

Parameters

Type	Name	Description
System.String	identifier
System.Byte[]	data

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

StorageBase.WriteAllBytesInternal(String, Byte[])

WriteAllTextInternal(String, String)

Declaration

protected override Task WriteAllTextInternal(string identifier, string data)

Parameters

Type	Name	Description
System.String	identifier
System.String	data

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

StorageBase.WriteAllTextInternal(String, String)

Implements

IStorage