Class AppendResult

Namespace

Cratis.Chronicle.EventSequences

Assembly

Cratis.Chronicle.dll

Represents the result of an append operation.

public record AppendResult : IAppendResult, IEquatable<AppendResult>

Inheritance

object

AppendResult

Implements

IAppendResult

IEquatable<AppendResult>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ConcurrencyViolation

Gets any concurrency violation that occurred during the operation.

public ConcurrencyViolation? ConcurrencyViolation { get; init; }

Property Value

ConcurrencyViolation

ConstraintViolations

Gets any violations that occurred during the operation.

public IEnumerable<ConstraintViolation> ConstraintViolations { get; init; }

Property Value

IEnumerable<ConstraintViolation>

CorrelationId

Gets the CorrelationId for the operation.

public CorrelationId CorrelationId { get; init; }

Property Value

CorrelationId

Errors

Gets any exception messages that might have occurred.

public IEnumerable<AppendError> Errors { get; init; }

Property Value

IEnumerable<AppendError>

HasConcurrencyViolations

Gets whether or not there are any concurrency violations that occurred.

public bool HasConcurrencyViolations { get; }

Property Value

bool

HasConstraintViolations

Gets whether or not there are any violations that occurred.

public bool HasConstraintViolations { get; }

Property Value

bool

HasErrors

Gets whether or not there are any errors that occurred.

public bool HasErrors { get; }

Property Value

bool

IsSuccess

Gets a value indicating whether the operation was successful.

public bool IsSuccess { get; }

Property Value

bool

SequenceNumber

Gets the sequence number of the event that was appended, if successful.

public EventSequenceNumber SequenceNumber { get; init; }

Property Value

EventSequenceNumber

Methods

Failed(CorrelationId, ConcurrencyViolation)

Create a failed result with a concurrency violation.

public static AppendResult Failed(CorrelationId correlationId, ConcurrencyViolation violation)

Parameters

correlationId CorrelationId

CorrelationId for the operation.

violation ConcurrencyViolation

The ConcurrencyViolation that occurred.

Returns

AppendResult

A new failed AppendResult instance.

Failed(CorrelationId, IEnumerable<AppendError>)

Create a failed result with errors.

public static AppendResult Failed(CorrelationId correlationId, IEnumerable<AppendError> errors)

Parameters

correlationId CorrelationId

CorrelationId for the operation.

errors IEnumerable<AppendError>

The errors.

Returns

AppendResult

A new failed AppendResult instance.

Failed(CorrelationId, IEnumerable<ConstraintViolation>)

Create a failed result with constraint violations.

public static AppendResult Failed(CorrelationId correlationId, IEnumerable<ConstraintViolation> violations)

Parameters

correlationId CorrelationId

CorrelationId for the operation.

violations IEnumerable<ConstraintViolation>

The violations.

Returns

AppendResult

A new failed AppendResult instance.

Success(CorrelationId, EventSequenceNumber)

Create a successful result.

public static AppendResult Success(CorrelationId correlationId, EventSequenceNumber sequenceNumber)

Parameters

correlationId CorrelationId

CorrelationId for the operation.

sequenceNumber EventSequenceNumber

EventSequenceNumber to report.

Returns

AppendResult

A new successful AppendResult instance.