Struct DataStoreKind
- Namespace
- Excalibur.Compliance
- Assembly
- Excalibur.Compliance.Abstractions.dll
Identifies the kind of store that holds personal data, used by the GDPR erasure coverage gate to route each discovered DataLocation to the mechanism that actually erases it (crypto-shred, a covering IErasureContributor, or a declared exemption).
public readonly struct DataStoreKind : IEquatable<DataStoreKind>
- Implements
- Inherited Members
Remarks
This is an extensible, string-backed kind (the Microsoft "names" pattern, e.g.
System.Net.Mime.MediaTypeNames) rather than a closed enum: Excalibur is a framework, so a
consumer may have custom stores holding personal data. A closed enum would force every custom
store into a single bucket, and a contributor declaring that bucket would then falsely "cover" all
unknown stores — a correctness hole. Use the well-known static members for first-party stores and
Create(string) for consumer-defined kinds.
Matching is case-insensitive value equality, so the kind behaves like an enum for set membership in
the coverage gate. The Unknown (default) kind is never coverable by a contributor
or an exemption — an unclassified location must block a Completed erasure, never silently pass.
Properties
Audit
The audit / security event store.
public static DataStoreKind Audit { get; }
Property Value
Cache
A cache store.
public static DataStoreKind Cache { get; }
Property Value
EventStore
The event store (covered by event tombstoning).
public static DataStoreKind EventStore { get; }
Property Value
Inbox
The inbox / deduplication store.
public static DataStoreKind Inbox { get; }
Property Value
IsUnknown
Gets a value indicating whether this is the unclassified (default) kind, which is never coverable.
public bool IsUnknown { get; }
Property Value
Outbox
The transactional outbox store.
public static DataStoreKind Outbox { get; }
Property Value
Projection
A read-model projection store.
public static DataStoreKind Projection { get; }
Property Value
Saga
The saga / process-manager state store.
public static DataStoreKind Saga { get; }
Property Value
Snapshot
The snapshot store.
public static DataStoreKind Snapshot { get; }
Property Value
Unknown
The unclassified/default store kind. Never coverable — always forces a non-Completed erasure.
public static DataStoreKind Unknown { get; }
Property Value
Value
Gets the normalized string value of this store kind.
public string Value { get; }
Property Value
- string
The store-kind identifier, or
"Unknown"for the default value.
Methods
Create(string)
Creates a DataStoreKind for a consumer-defined store kind.
public static DataStoreKind Create(string value)
Parameters
valuestringThe non-empty store-kind identifier (trimmed; matched case-insensitively).
Returns
- DataStoreKind
A DataStoreKind wrapping the normalized value.
Exceptions
- ArgumentException
Thrown when
valueis null or whitespace.
Equals(DataStoreKind)
Indicates whether the current object is equal to another object of the same type.
public bool Equals(DataStoreKind other)
Parameters
otherDataStoreKindAn object to compare with this object.
Returns
Equals(object?)
Indicates whether this instance and a specified object are equal.
public override bool Equals(object? obj)
Parameters
objobjectThe object to compare with the current instance.
Returns
- bool
true if
objand this instance are the same type and represent the same value; otherwise, false.
GetHashCode()
Returns the hash code for this instance.
public override int GetHashCode()
Returns
- int
A 32-bit signed integer that is the hash code for this instance.
ToString()
Returns the fully qualified type name of this instance.
public override string ToString()
Returns
- string
The fully qualified type name.
Operators
operator ==(DataStoreKind, DataStoreKind)
Determines whether two store kinds are equal (case-insensitive).
public static bool operator ==(DataStoreKind left, DataStoreKind right)
Parameters
leftDataStoreKindrightDataStoreKind
Returns
operator !=(DataStoreKind, DataStoreKind)
Determines whether two store kinds are not equal (case-insensitive).
public static bool operator !=(DataStoreKind left, DataStoreKind right)
Parameters
leftDataStoreKindrightDataStoreKind