package kcas_data

  1. Overview
  2. Docs

Module Queue.XtSource

Explicit transaction log passing on queues.

Sourceval is_empty : xt:'x Kcas.Xt.t -> 'a t -> bool

is_empty s determines whether the queue q is empty.

Sourceval length : xt:'x Kcas.Xt.t -> 'a t -> int

length q returns the length of the queue q.

Sourceval clear : xt:'x Kcas.Xt.t -> 'a t -> unit

clear q removes all elements from the queue q.

Sourceval swap : xt:'x Kcas.Xt.t -> 'a t -> 'a t -> unit

swap q1 q2 exchanges the contents of the queues q1 and q2.

Sourceval to_seq : xt:'x Kcas.Xt.t -> 'a t -> 'a Seq.t

to_seq s returns a domain safe sequence for iterating through the elements of the queue front to back.

The sequence is based on a constant time, O(1), snapshot of the queue and modifications of the queue have no effect on the sequence.

Sourceval add : xt:'x Kcas.Xt.t -> 'a -> 'a t -> unit

add q x adds the element x at the end of the queue q.

Sourceval push : xt:'x Kcas.Xt.t -> 'a -> 'a t -> unit

push is a synonym for add.

Sourceval peek_opt : xt:'x Kcas.Xt.t -> 'a t -> 'a option

peek_opt q returns the first element in queue q, without removing it from the queue, or returns None if the queue is empty.

Sourceval take_opt : xt:'x Kcas.Xt.t -> 'a t -> 'a option

take_opt q removes and returns the first element in queue q, or returns None if the queue is empty.