Interface IReadOnlyReorderableEventQueue<TEvent, TPoint, TPointDelta>

Namespace

LfrlAnvil.Reactive.Queues

Assembly

LfrlAnvil.Reactive.Queues.dll

Represents a generic read-only event queue that allows to modify registered events.

public interface IReadOnlyReorderableEventQueue<TEvent, TPoint, TPointDelta> : IReadOnlyEventQueue<TEvent, TPoint, TPointDelta>, IReadOnlyCollection<EnqueuedEvent<TEvent, TPoint, TPointDelta>>, IEnumerable<EnqueuedEvent<TEvent, TPoint, TPointDelta>>, IEnumerable

Type Parameters

TEvent

Event type.

TPoint

Queue point type.

TPointDelta

Queue point delta type.

Inherited Members

IReadOnlyEventQueue<TEvent, TPoint, TPointDelta>.StartPoint

IReadOnlyEventQueue<TEvent, TPoint, TPointDelta>.CurrentPoint

IReadOnlyEventQueue<TEvent, TPoint, TPointDelta>.Comparer

IReadOnlyEventQueue<TEvent, TPoint, TPointDelta>.GetNext()

IReadOnlyEventQueue<TEvent, TPoint, TPointDelta>.GetEvents(TPoint)

IReadOnlyCollection<EnqueuedEvent<TEvent, TPoint, TPointDelta>>.Count

IEnumerable<EnqueuedEvent<TEvent, TPoint, TPointDelta>>.GetEnumerator()

IEnumerable.GetEnumerator()

Properties

EventComparer

Event equality comparer.

IEqualityComparer<TEvent> EventComparer { get; }

Property Value

IEqualityComparer<TEvent>

Methods

Contains(TEvent)

Checks whether or not this queue contains the specified event.

[Pure]
bool Contains(TEvent @event)

Parameters

event TEvent

Event to check.

Returns

bool

true when event exists, otherwise false.

GetEvent(TEvent)

Attempts to return event information.

[Pure]
EnqueuedEvent<TEvent, TPoint, TPointDelta>? GetEvent(TEvent @event)

Parameters

event TEvent

Event to get information for.

Returns

EnqueuedEvent<TEvent, TPoint, TPointDelta>?

EnqueuedEvent<TEvent, TPoint, TPointDelta> instance associated with the provided event or null when event does not exist.