Std.RingBuffer

12 public declarations

• capacity&Std.RingBuffer.RingBuffer -> Int

  Returns the total power-of-two capacity of the buffer.

  fn
• clear&Std.RingBuffer.RingBuffer -> Std.RingBuffer.RingBuffer

  Clears all elements from the ring buffer.

  fn
• createInt -> Std.RingBuffer.RingBuffer

  Creates a ring buffer whose capacity is rounded up to the nearest power of two (min 4).

  fn
• isEmpty&Std.RingBuffer.RingBuffer -> Bool

  Whether the buffer contains no elements.

  fn
• isFull&Std.RingBuffer.RingBuffer -> Bool

  Whether the buffer has reached maximum capacity.

  fn
• peek&Std.RingBuffer.RingBuffer -> Option[Int]

  Peeks at the item at the head of the buffer without removing it.

  fn
• pop&Std.RingBuffer.RingBuffer -> Option[Std.RingBuffer.PopResult]

  Dequeues an item from the head of the buffer. Returns None if the buffer is empty.

  fn
• PopResult

  The result of a successful pop operation containing the updated buffer and the dequeued item.

  type
• push&Std.RingBuffer.RingBuffer -> Int -> Option[Std.RingBuffer.RingBuffer]

  Enqueues an item at the tail of the buffer. Returns None if the buffer is full.

  fn
• RingBuffer

  A bounded, power-of-two circular FIFO ring buffer with branchless bitmask wrapping.

  type
• size&Std.RingBuffer.RingBuffer -> Int

  Returns the number of elements currently stored.

  fn
• toArray&Std.RingBuffer.RingBuffer -> Array[Int]

  Returns the elements in FIFO order from head to tail.

  fn