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

Definition

Namespace:

System.Collections.Immutable

Assembly:

System.Collections.Immutable.dll

Package:

System.Collections.Immutable v9.0.0-rc.2.24473.5

Source:

ImmutableQueue.cs

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

public:
generic <typename T>
[System::Runtime::CompilerServices::Extension]
 static System::Collections::Immutable::IImmutableQueue<T> ^ Dequeue(System::Collections::Immutable::IImmutableQueue<T> ^ queue, [Runtime::InteropServices::Out] T % value);

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

static member Dequeue : System.Collections.Immutable.IImmutableQueue<'T> * 'T -> System.Collections.Immutable.IImmutableQueue<'T>

<Extension()>
Public Function Dequeue(Of T) (queue As IImmutableQueue(Of T), ByRef value As T) As IImmutableQueue(Of T)

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

IImmutableQueue<T>

The new queue with the item removed.

Exceptions

InvalidOperationException

The stack is empty.