Class EntityScope<T, TKey>

Namespace

Tharga.MongoDB.Lockable

Assembly

Tharga.MongoDB.dll

public record EntityScope<T, TKey> : IAsyncDisposable, IDisposable, IEquatable<EntityScope<T, TKey>> where T : LockableEntityBase<TKey>

Type Parameters

T

TKey

Inheritance

object

EntityScope<T, TKey>

Implements

IAsyncDisposable

IDisposable

IEquatable<EntityScope<T, TKey>>

Derived

EntityScope<T>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

EntityScopeExtensions.ExecuteAsync<T, TKey>(EntityScope<T, TKey>, Func<T, Task<T>>, Action<Exception>)

EntityScopeExtensions.ExecuteAsync<T, TKey>(EntityScope<T, TKey>, Func<T, Task<T>>, Action<LockableErrorKind, Exception>)

Properties

Entity

public T Entity { get; }

Property Value

T

Methods

AbandonAsync()

Releases the lock without any changes to the entity.

public Task AbandonAsync()

Returns

Task

CommitAsync(T)

Saves updates back to the database and release the lock.

public Task<T> CommitAsync(T updatedEntity = null)

Parameters

updatedEntity T

Returns

Task<T>

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

DisposeAsync()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.

public ValueTask DisposeAsync()

Returns

ValueTask

A task that represents the asynchronous dispose operation.

SetErrorStateAsync(Exception)

Sets an exception on the lock.

public Task SetErrorStateAsync(Exception exception)

Parameters

exception Exception

Returns

Task