Class IdempotencyKey

Namespace

Cratis.Chronicle.EventSequences

Assembly

Cratis.Chronicle.dll

Represents a caller-chosen key that makes an append idempotent: appending again with the same key never writes the event twice.

public record IdempotencyKey : ConceptAs<string>, IComparable<ConceptAs<string>>, IComparable<string>, IComparable, IEquatable<ConceptAs<string>>, IEquatable<IdempotencyKey>

Inheritance

object

ConceptAs<string>

IdempotencyKey

Implements

IComparable<ConceptAs<string>>

IComparable<string>

IComparable

IEquatable<ConceptAs<string>>

IEquatable<IdempotencyKey>

Inherited Members

ConceptAs<string>.CompareTo(ConceptAs<string>)

ConceptAs<string>.CompareTo(string)

ConceptAs<string>.CompareTo(object)

ConceptAs<string>.ToString()

ConceptAs<string>.Value

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Extension Methods

MethodCalls.CallGenericMethod<TOut, T>(T, Expression<Func<T, Func<TOut>>>, params Type[])

MethodCalls.CallGenericMethod<TOut, T, T1>(T, Expression<Func<T, Func<T1, TOut>>>, T1, params Type[])

MethodCalls.CallGenericMethod<TOut, T, T1, T2>(T, Expression<Func<T, Func<T1, T2, TOut>>>, T1, T2, params Type[])

MethodCalls.CallGenericMethod<TOut, T, T1, T2, T3>(T, Expression<Func<T, Func<T1, T2, T3, TOut>>>, T1, T2, T3, params Type[])

ConverterExtensions.ConvertTo(object, Type)

ConceptExtensions.GetConceptValue(object)

ConceptExtensions.IsConcept(object)

JsonValueExtensions.ToJsonValue(object?)

ObservableExtensions.InvokeAndWrapWithSubject<TResult>(object, Func<CancellationToken, IObservable<TResult>>)

ObservableExtensions.InvokeAndWrapWithTransformSubject<TResult, TSource>(object, Func<CancellationToken, IObservable<TSource>>, Func<TSource, TResult>)

Remarks

There is deliberately no implicit conversion from string; a key is always created explicitly. Never put personal data in a key - it is stored with the event.

Constructors

IdempotencyKey(IdempotencyKey)

protected IdempotencyKey(IdempotencyKey original)

Parameters

original IdempotencyKey

IdempotencyKey(string)

Initializes a new instance of the IdempotencyKey record.

public IdempotencyKey(string value)

Parameters

value string

The key, 1 to MaximumLength characters.

Exceptions

IdempotencyKeyNotValid

The key is empty or longer than MaximumLength.

Fields

MaximumLength

The maximum number of characters in a key.

public const int MaximumLength = 512

Field Value

int

Properties

EqualityContract

protected override Type EqualityContract { get; }

Property Value

Type

Methods

Equals(IdempotencyKey?)

public virtual bool Equals(IdempotencyKey? other)

Parameters

other IdempotencyKey

Returns

bool

Equals(ConceptAs<string>?)

public override sealed bool Equals(ConceptAs<string>? other)

Parameters

other ConceptAs<string>

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

ForIndex(int)

Derives the key for one event of a batch, so a batch keyed once is keyed per event.

public IdempotencyKey ForIndex(int index)

Parameters

index int

The zero-based position of the event in the batch.

Returns

IdempotencyKey

A derived key of 64 characters.

GetHashCode()

public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder)

protected override bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

Operators

operator ==(IdempotencyKey?, IdempotencyKey?)

public static bool operator ==(IdempotencyKey? left, IdempotencyKey? right)

Parameters

left IdempotencyKey

right IdempotencyKey

Returns

bool

operator !=(IdempotencyKey?, IdempotencyKey?)

public static bool operator !=(IdempotencyKey? left, IdempotencyKey? right)

Parameters

left IdempotencyKey

right IdempotencyKey

Returns

bool