Class CollectionOnDriveBase<T>

Namespace

SunamoCollectionOnDrive

Assembly

SunamoCollectionOnDrive.dll

Base class for collections that persist their content to a file on disk.

public abstract class CollectionOnDriveBase<T> : List<T>, IList<T>, ICollection<T>, IReadOnlyList<T>, IReadOnlyCollection<T>, IEnumerable<T>, IList, ICollection, IEnumerable

Type Parameters

T

Type of items in the collection.

Inheritance

object

List<T>

CollectionOnDriveBase<T>

Implements

IList<T>

ICollection<T>

IReadOnlyList<T>

IReadOnlyCollection<T>

IEnumerable<T>

IList

ICollection

IEnumerable

Derived

CollectionOnDrive

CollectionOnDriveT<T>

Inherited Members

List<T>.Add(T)

List<T>.AddRange(IEnumerable<T>)

List<T>.AsReadOnly()

List<T>.BinarySearch(int, int, T, IComparer<T>)

List<T>.BinarySearch(T)

List<T>.BinarySearch(T, IComparer<T>)

List<T>.Clear()

List<T>.Contains(T)

List<T>.ConvertAll<TOutput>(Converter<T, TOutput>)

List<T>.CopyTo(int, T[], int, int)

List<T>.CopyTo(T[])

List<T>.CopyTo(T[], int)

List<T>.EnsureCapacity(int)

List<T>.Exists(Predicate<T>)

List<T>.Find(Predicate<T>)

List<T>.FindAll(Predicate<T>)

List<T>.FindIndex(int, int, Predicate<T>)

List<T>.FindIndex(int, Predicate<T>)

List<T>.FindIndex(Predicate<T>)

List<T>.FindLast(Predicate<T>)

List<T>.FindLastIndex(int, int, Predicate<T>)

List<T>.FindLastIndex(int, Predicate<T>)

List<T>.FindLastIndex(Predicate<T>)

List<T>.ForEach(Action<T>)

List<T>.GetEnumerator()

List<T>.GetRange(int, int)

List<T>.IndexOf(T)

List<T>.IndexOf(T, int)

List<T>.IndexOf(T, int, int)

List<T>.Insert(int, T)

List<T>.InsertRange(int, IEnumerable<T>)

List<T>.LastIndexOf(T)

List<T>.LastIndexOf(T, int)

List<T>.LastIndexOf(T, int, int)

List<T>.Remove(T)

List<T>.RemoveAll(Predicate<T>)

List<T>.RemoveAt(int)

List<T>.RemoveRange(int, int)

List<T>.Reverse()

List<T>.Reverse(int, int)

List<T>.Slice(int, int)

List<T>.Sort()

List<T>.Sort(IComparer<T>)

List<T>.Sort(Comparison<T>)

List<T>.Sort(int, int, IComparer<T>)

List<T>.ToArray()

List<T>.TrimExcess()

List<T>.TrueForAll(Predicate<T>)

List<T>.Capacity

List<T>.Count

List<T>.this[int]

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

FuncExtensions.AsFuncFast<T>(T)

FuncExtensions.AsFunc<T>(T)

IListExtensions.Count2<T>(IList<T>)

IListExtensions.DumpAsString<T>(IList<T>, string, object)

IListExtensions.Length2<T>(IList<T>)

IListExtensions.RemoveAt<T>(IList<T>, int)

IListExtensions.RemoveLast<T>(IList<T>)

IListExtensions.Swap<T>(IList<T>, int, int)

IListExtensions.TakeLast<T>(IList<T>, int)

IListExtensions.Where2<TSource>(IList<TSource>, Func<TSource, bool>)

ListExtensions.AddOrSet<T>(IList<T>, int, T)

ListExtensions.AddRangeIfNotContain<T>(IList<T>, List<T>)

ListExtensions.Insert<T>(IList<T>, int, T)

ListExtensions.RemoveMany<T>(IList<T>, List<T>)

NH.Median<T>(IList<T>, Func<T, double>)

TableParser.ToStringTable<T>(List<T>, List<string>, params Func<T, object>[])

IListExtensions.SortAsc<T>(List<T>)

IListExtensions.Count(IEnumerable)

IListExtensions.FirstOrNull(IEnumerable)

IListExtensions.Count3(IList)

IListExtensions.First2(IList)

IListExtensions.WhereNonGeneric(IList, Func<object, bool>)

ObjectExtensions.GetStackTrace(object)

ReClasser.FixMeUp(object)

Constructors

CollectionOnDriveBase(ILogger)

Initializes a new instance of the CollectionOnDriveBase class.

protected CollectionOnDriveBase(ILogger logger)

Parameters

logger ILogger

Logger instance for logging operations.

Properties

Args

Configuration arguments for the collection.

protected CollectionOnDriveArgs Args { get; set; }

Property Value

CollectionOnDriveArgs

IsRemovingDuplicates

Whether duplicates should be removed on load and whether duplicate items should not even be saved.

protected bool IsRemovingDuplicates { get; set; }

Property Value

bool

Logger

Logger instance for this collection.

protected ILogger Logger { get; }

Property Value

ILogger

Methods

AddWithSave(T?)

Adds a value to the collection and saves to disk. Checks for duplicates if IsRemovingDuplicates is enabled.

public virtual Task<bool> AddWithSave(T? value)

Parameters

value T

Value to add.

Returns

Task<bool>

True if the value was added and saved, false if it was a duplicate or empty.

Exceptions

Exception

Thrown if value is null or ToString returns null.

AddWithoutSave(T)

Adds a value to the collection without saving to disk. Checks for duplicates if IsRemovingDuplicates is enabled.

public virtual void AddWithoutSave(T value)

Parameters

value T

Value to add.

ClearWithSave()

Clears the collection and saves the empty state.

public Task ClearWithSave()

Returns

Task

Init(CollectionOnDriveArgs)

Initializes the collection with configuration arguments. Call Load() afterwards to load existing records.

public void Init(CollectionOnDriveArgs arguments)

Parameters

arguments CollectionOnDriveArgs

Configuration arguments including file path and whether to watch for changes.

Load(bool)

Loads the collection from disk.

public abstract Task Load(bool isRemovingDuplicates)

Parameters

isRemovingDuplicates bool

Whether to remove duplicate entries when loading.

Returns

Task

RemoveAll()

Removes all items from the collection and clears the file on disk.

public Task RemoveAll()

Returns

Task

RemoveWithSave(T)

Removes a specific value from the collection and saves the changes.

public Task RemoveWithSave(T value)

Parameters

value T

Value to remove.

Returns

Task

Save()

Saves the collection to disk, removing duplicates.

public Task Save()

Returns

Task

ToString()

Returns a string representation of the collection with items separated by newlines.

public override string ToString()

Returns

string

All items joined by newlines.