| | | 1 | | //======================================================================= |
| | | 2 | | // SwiftHandle.cs |
| | | 3 | | //======================================================================= |
| | | 4 | | // MIT License, Copyright (c) 2024–present David Oravsky (mrdav30) |
| | | 5 | | // See LICENSE file in the project root for full license information. |
| | | 6 | | //======================================================================= |
| | | 7 | | |
| | | 8 | | using System; |
| | | 9 | | |
| | | 10 | | namespace SwiftCollections; |
| | | 11 | | |
| | | 12 | | /// <summary> |
| | | 13 | | /// Represents a value type handle that uniquely identifies an object or resource by index and generation. |
| | | 14 | | /// </summary> |
| | | 15 | | /// <remarks> |
| | | 16 | | /// A <see cref="SwiftHandle"/> consists of an integer index and an unsigned generation value. |
| | | 17 | | /// This combination helps detect stale or invalid references when resources are recycled. |
| | | 18 | | ///</remarks> |
| | | 19 | | public readonly struct SwiftHandle : IEquatable<SwiftHandle> |
| | | 20 | | { |
| | | 21 | | /// <summary> |
| | | 22 | | /// Gets the zero-based index associated with this instance. |
| | | 23 | | /// </summary> |
| | | 24 | | public readonly int Index; |
| | | 25 | | |
| | | 26 | | /// <summary> |
| | | 27 | | /// Gets the generation number associated with this instance. |
| | | 28 | | /// </summary> |
| | | 29 | | public readonly uint Generation; |
| | | 30 | | |
| | | 31 | | /// <summary> |
| | | 32 | | /// Initializes a new instance of the SwiftHandle class with the specified index and generation values. |
| | | 33 | | /// </summary> |
| | | 34 | | /// <param name="index"> |
| | | 35 | | /// The zero-based index that identifies the handle. |
| | | 36 | | /// Must be greater than or equal to 0. |
| | | 37 | | /// </param> |
| | | 38 | | /// <param name="generation"> |
| | | 39 | | /// The generation value associated with the handle. |
| | | 40 | | /// Used to distinguish between different versions of the same index. |
| | | 41 | | /// </param> |
| | | 42 | | public SwiftHandle(int index, uint generation) |
| | | 43 | | { |
| | 363 | 44 | | Index = index; |
| | 363 | 45 | | Generation = generation; |
| | 363 | 46 | | } |
| | | 47 | | |
| | | 48 | | /// <inheritdoc/> |
| | | 49 | | public bool Equals(SwiftHandle other) |
| | 5 | 50 | | => Index == other.Index && Generation == other.Generation; |
| | | 51 | | |
| | | 52 | | /// <inheritdoc/> |
| | | 53 | | public override bool Equals(object? obj) |
| | 2 | 54 | | => obj is SwiftHandle h && Equals(h); |
| | | 55 | | |
| | | 56 | | /// <inheritdoc/> |
| | | 57 | | public override int GetHashCode() |
| | 2 | 58 | | => HashCode.Combine(Index, Generation); |
| | | 59 | | |
| | | 60 | | /// <summary> |
| | | 61 | | /// Returns a string that represents the current handle, including its index and generation values. |
| | | 62 | | /// </summary> |
| | | 63 | | /// <returns>A string in the format "Handle({Index}:{Generation})" that identifies the handle by its index and gener |
| | | 64 | | public override string ToString() |
| | 1 | 65 | | => $"Handle({Index}:{Generation})"; |
| | | 66 | | |
| | | 67 | | /// <summary> |
| | | 68 | | /// Determines whether two SwiftHandle instances are equal. |
| | | 69 | | /// </summary> |
| | 2 | 70 | | public static bool operator ==(SwiftHandle left, SwiftHandle right) => left.Equals(right); |
| | | 71 | | |
| | | 72 | | /// <summary> |
| | | 73 | | /// Determines whether two SwiftHandle instances are not equal. |
| | | 74 | | /// </summary> |
| | 1 | 75 | | public static bool operator !=(SwiftHandle left, SwiftHandle right) => !(left == right); |
| | | 76 | | } |