Header menu logo TDesu.FSharp

BoundedQueue<'T> Type

Bounded queue — auto-evicts oldest elements when capacity is reached. Not thread-safe.

Constructors

Constructor Description

BoundedQueue(capacity)

Full Usage: BoundedQueue(capacity)

Parameters:
    capacity : int

Returns: BoundedQueue<'T>
capacity : int
Returns: BoundedQueue<'T>

Instance members

Instance member Description

this.Clear

Full Usage: this.Clear

Clears all items.

this.Count

Full Usage: this.Count

Returns: int

Number of items in the queue.

Returns: int

this.Dequeue

Full Usage: this.Dequeue

Returns: 'T

Dequeues the oldest item.

Returns: 'T

this.Enqueue

Full Usage: this.Enqueue

Parameters:
    item : 'T

Enqueues an item. If at capacity, dequeues the oldest first. The item to enqueue.

item : 'T

this.Peek

Full Usage: this.Peek

Returns: 'T

Peeks at the oldest item without removing.

Returns: 'T

this.ToSeq

Full Usage: this.ToSeq

Returns: 'T seq

Returns all items as a sequence.

Returns: 'T seq

this.TryDequeue

Full Usage: this.TryDequeue

Parameters:
    result : byref<'T>

Returns: bool

Tries to dequeue, returns true + value if successful. When successful, receives the dequeued item.

result : byref<'T>
Returns: bool

Type something to start searching.