ManagedGuidSet 2.0.0

ManagedGuidSet

A thread-safe HashSet<Guid> which stores upto a set capacity discarding older Guids as needed.

Useful for keeping track of old vs new things.

Features

1. Loading saved Guids upon construction.
2. Save current Guids for later loading.
3. Set the capacity.
4. See if a Guid is present in collection.
5. Enumerable.

Time Complexities

• Add: O(1)
• Remove: O(1)
• Contains: O(1)
• Clear: O(1)
• Save: O(n)
• Load: O(n)

Usage

Properties

/// <summary>
/// The maximum amount of items until old items are discarded.
/// </summary>
public int Capacity

/// <summary>
/// How many items are currently in the collection.
/// </summary>
public int Size

Constructor

/// <summary>
/// Creates a new ManagedLookup collection.
/// </summary>
/// <param name="capacity">The initial capacity of the collection.</param>
/// <param name="path">The path to load saved Guids from.</param>
public ManagedGuidSet(int capacity = 3, string? path = null)

Methods

/// <summary>
/// Checks to see if a specific Guid is already in the collection.
/// </summary>
/// <param name="guid">The Guid to check.</param>
/// <returns>true if the specified Guid is present in the collection, false otherwise.</returns>
public bool Contains(Guid guid)

/// <summary>
/// Adds a Guid to the collection.
/// </summary>
/// <param name="guid">The Guid to be added.</param>
/// <returns>true if the Guid was added successfully, false otherwise.</returns>
public bool Add(Guid guid)

/// <summary>
/// Tries to remove the oldest item from the collection.
/// </summary>
/// <param name="guid">The removed Guid.</param>
/// <returns>true if an item was removed from the collection, false otherwise.</returns>
public bool TryRemove(out Guid? guid)

/// <summary>
/// Clears the collection.
/// </summary>
public void Clear()

/// <summary>
/// Saves the collection to disk.
/// </summary>
/// <param name="path">The full save path.</param>
/// <returns>true if save was successful, false otherwise.</returns>
public async Task<bool> Save(string? path = null)

Example

// Create a ManagedGuidSet with capacity of 600
ManagedGuidSet mgs = new(600);

// Adding a Guid
Guid newGuid = Guid.NewGuid();
mgs.Add(newGuid);

// Checking to see if the Guid is present
bool isPresent =  mgs.Contains(newGuid);

// Removing the oldest Guid
if(mgs.TryRemove(out Guid? oldGuid))
{
    Console.WriteLine($"Removed old Guid: {oldGuid}");
}
else
{
    Console.WriteLine("Collection is Empty");
}

// Saving the collection to disk
string path = "some path here";
if(await msg.Save("Some Path here"))
    Console.WriteLine("Saved.");

// Loading saved collection on construction with a new capacity of 300
ManagedGuidSet mgs2 = new(300, path);