ImmutableQueue.Dequeue<T>(IImmutableQueue<T>, T) Method

Definition

Removes the item at the beginning of the immutable queue, and returns the new queue.

C#
public static System.Collections.Immutable.IImmutableQueue<T> Dequeue<T>(this System.Collections.Immutable.IImmutableQueue<T> queue, out T value);

Type Parameters

T

The type of elements in the immutable queue.

Parameters

queue
IImmutableQueue<T>

The queue to remove the item from.

value
T

When this method returns, contains the item from the beginning of the queue.

Returns

The new queue with the item removed.

Exceptions

The stack is empty.

Applies to

Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8 (package-provided), 8, 9 (package-provided), 9
.NET Framework 4.7 (package-provided), 4.7.1 (package-provided), 4.7.2 (package-provided), 4.8 (package-provided)
.NET Standard 2.0 (package-provided)
UWP 10.0